0% found this document useful (0 votes)
195 views5,388 pages

Sysview 170 Command Help 2024-03-01

Uploaded by

calanngo
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
195 views5,388 pages

Sysview 170 Command Help 2024-03-01

Uploaded by

calanngo
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 5388

SYSVIEW® Performance Management

Release 17.0
Command Reference
Date: 1 Mar 2024
SYSVIEW® Performance Management - 17.0

This Documentation, which includes embedded help systems and electronically distributed
materials, (hereinafter referred to as the "Documentation") is for your informational purposes
only and is subject to change or withdrawal by Broadcom at any time. This Documentation is
proprietary information of Broadcom and may not be copied, transferred, reproduced,
disclosed, modified or duplicated, in whole or in part, without the prior written consent of
Broadcom.

If you are a licensed user of the software product(s) addressed in the Documentation, you may
print or otherwise make available a reasonable number of copies of the Documentation for
internal use by you and your employees in connection with that software, provided that all
Broadcom copyright notices and legends are affixed to each reproduced copy.

The right to print or otherwise make available copies of the Documentation is limited to the
period during which the applicable license for such software remains in full force and effect.
Should the license terminate for any reason, it is your responsibility to certify in writing to
Broadcom that all copies and partial copies of the Documentation have been returned to
Broadcom or destroyed.

TO THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS


DOCUMENTATION "AS IS" WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL BROADCOM BE LIABLE TO YOU OR ANY
THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS
DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT,
BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS EXPRESSLY
ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.

The use of any software product referenced in the Documentation is governed by the
applicable license agreement and such license agreement is not modified in any way by the
terms of this notice. The manufacturer of this Documentation is Broadcom Inc. Provided with
"Restricted Rights." Use, duplication or disclosure by the United States Government is subject
to the restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and
DFARS Section 252.227-7014(b)(3), as applicable, or their successors.
Table Of Contents

 ABENDX - Abend exits


 ACTIVITY - System activity
 ACTJOB - Job activity
 ACTSUM - Job activity summary
 ADREGION - Display region for an address
 ALERTS - MVS exception alerts
 ALERTSUM - Exception alert summary
 ALLFILES - Include all JES data sets
 ALLIST - Access lists
 ALLOCAS - Device allocation status
 ALLOCDS - Data sets allocated on a volume
 AMBLIST - AMBLIST utility interface
 APFLIST - APF list data sets
 APFSERV - APF list services
 APFSTAT - APF list data set status
 APFTEST - Test data set for APF auth
 APPLMON - VTAM application monitor
 APPLMOND - VTAM application monitor detail
 AR - Control AR mode
 ASADMIN - Address space administration
 ASCANCEL - Cancel an address space
 ASCANTSK - Cancel a task within an addrspc
 ASEXTRAC - Extract address space variables
 ASFETCH - Fetch and unfetch statistics
 ASFORCE - Force an address space
 ASID - Set target address space
 ASITYPES - Address space ident types
 ASKILL - Kill an address space
 ASLIST - Address space list
 ASLOCKS - Address space suspend locks
 ASLOST - Lost address spaces
 ASNOSWAP - Set address space nonswappable
 ASOKSWAP - Set address space swappable
 ASOPTION - Set address space cmd options
 ASPERF - Address space performance
 ASQUERY - Query address space variables
 ASQUIESC - Set address space quiesced
 ASRESUME - Set address space unquiesced
 ASSET - Set address space attributes
 ATLIST - Authorization table
 ATTNX - Attention exits
 AUDITDEF - Audit event definitions
 AUDITLOG - Audit event log
 AUDITMSG - Create audit event message
 AXATABLE - Auth index allocation table
 BOOST - System recovery boost
 BOTTOM - Scroll to bottom of display
 BROWSE - Browse data with ISPF BROWSE
 CACHECTL - Cache controllers
 CACHEDEV - Cache devices
 CADCONS - CCS data consumers
 CADMOVER - CCS data mover information
 CADPROD - CCS data producers
 CAICCI - CCI inquiry
 CAIDS - CICS auto initiate descriptors
 CAILMP - LMP information
 CAIRIM - CAIRIM installed products
 CAISMF - CAISMF SMF intercepts
 CALC - Calculator
 CALENDAR - Calendar
 CALERTS - CICS exception alerts
 CAMASM - CAMASTER address space mgt
 CAMASTER - Configure CAMASTER services
 CAMPCS - CAMASTER PC services
 CAPCLOSE - Capture close
 CAPDISP - Capture display
 CAPEVENT - Captured event
 CAPIMMED - Capture immediate
 CAPLIB - CAPLIB libraries
 CAPLIST - Captured event list
 CAPMAINT - Capture index maintenance
 CAPNOTE - Capture notes
 CAPOPEN - Capture open
 CAPPARMS - Capture parameters
 CAPQUERY - Capture query
 CAPTURE - Capture event
 CARTM - CICS auto response time mgmt
 CATALOG - Catalogs
 CATOMS - CICS atom services
 CATPERF - Catalog performance
 CAVARS - CCS common variables
 CBUNDLES - CICS bundles
 CBUNDPAR - CICS bundle parts
 CCEDA - CICS CEDA command response
 CCEMT - CICS CEMT command response
 CCHANNEL - CICS channels
 CCONFIG - CICS configuration options
 CCONN - CICS connections
 CCONTAIN - CICS containers
 CDATAMON - CICS data monitoring stats
 CDATATBL - CICS data tables
 CDBCTL - CICS DB control
 CDB2CONN - CICS DB2 connections
 CDB2CSUB - CICS DB2 connection state blocks
 CDB2ENTR - CICS DB2 entries
 CDB2TRAN - CICS DB2 transactions
 CDFHCNV - CICS DFHCNV conversion table
 CDIR - CICS directory domain elements
 CDISP - CICS dispatcher information
 CDOCTEMP - CICS document handler templates
 CDOMAINS - CICS domains
 CDSAS - CICS dynamic storage areas
 CDSAX - CICS dynamic storage area extent
 CDUMPMGT - CICS dump management
 CDUMPS - CICS dump statistics
 CEDA - CICS CEDA command function
 CEITLOG - CICS EXEC Interface trace log
 CEITRACE - CICS EXEC Interface trace
 CELEMENT - CICS dynamic storage elements
 CELLPOOL - Cell pools allocated
 CEMT - CICS CEMT command function
 CENQMOD - CICS enqueue models
 CENQPOOL - CICS enqueue pools
 CENQUEUE - CICS enqueues
 CEPBS - CICS exit program blocks
 CFCACHE - Coupling facility cache stats
 CFCONFIG - Coupling facility configuration
 CFILEREQ - CICS file request statistics
 CFILES - CICS file control table entries
 CFILEUSE - CICS files in use
 CFLIST - Coupling facility summary
 CFPATH - Coupling facility I/O paths
 CFPROC - Coupling facility processors
 CFSTRUCT - Coupling facility structures
 CFUSER - Coupling facility users
 CGATES - CICS domain gates
 CGBLEXIT - CICS global user exits
 CHANPATH - Channel paths
 CHOSTS - CICS virtual hosts
 CICE - CICS interval control elements
 CICS - Set target CICS
 CICSDATA - Set CICS data collection options
 CICSLIST - CICS regions
 CICSLOGR - CICS data loggers
 CICSLOGS - CICS logger topology
 CICSSET - Alter CICS resources
 CIPCONN - CICS IP connections
 CJINFO - CICS journal information
 CJMODEL - CICS journal models
 CJVMPROG - CICS JVM programs
 CJVMSERV - CICS JVM servers
 CKTCB - CICS kernel tasks
 CLIBS - CICS libraries
 CLIFE - CICS lifetime range statistics
 CLIFESUM - CICS lifetime summary
 CLIST - Execute a command list
 CLISTLIB - CLISTLIB libraries
 CLOCKMGR - CICS lock manager
 CMCT - CICS monitor control table
 CMDACT - Command activity
 CMDATTR - Set command attributes
 CMDUSAGE - Command usage
 CMODES - CICS modenames
 CMODS - CICS data collection modules
 CMONITOR - CICS monitor domain information
 CMONSTAT - CICS monitor status
 CMQCONN - CICS MQ connection
 CMQMON - CICS MQ monitor definitions
 CMQTASKS - CICS MQ tasks
 COLS - Control display of columns line
 COMMANDS - List commands and subcommands
 COMMENT - Comment
 COMMON - Common area storage usage
 CONFIRM - Confirmation prompt testing
 CONFLICT - Enqueue conflicts
 CONSOLE - System console
 CONTROL - Set CLIST execution options
 CPCGROUP - CPC capacity group
 CPCLPAR - CPC LPAR capacity information
 CPCSUM - CPC LPAR capacity summary
 CPFTABLE - Command prefix table
 CPIPE - CICS pipelines
 CPROCTYP - CICS process types
 CPROFILE - CICS profiles
 CPROGRAM - CICS program statistics
 CPROGUSE - CICS program usage
 CPU - CPU information
 CPUSUM - CPU summary
 CREMOTE - CICS remote system connection
 CRESUSE - CICS resource usage
 CREVIEW - CICS transaction activity
 CSCHEDUL - CICS scheduled events
 CSFBUSY - Datacom CSF TCB Utilization
 CSFCODES - Datacom CSF return codes
 CSFIO - Datacom CSF TCB start I/O
 CSFLOAD - Datacom CSF load module list
 CSFMUFS - Datacom CSF MUFs
 CSFOPTS - Datacom CSF generation options
 CSFREQS - Datacom CSF request statistics
 CSFTABLE - Datacom CSF URT file tables
 CSFTASKS - Datacom CSF TCB tasks
 CSFTCBS - Datacom CSF TCB activity
 CSFTCBW - Datacom CSF TCB waits
 CSFTRACE - Datacom CSF trace
 CSFURTS - Datacom CSF URTs
 CSFUSERS - Datacom CSF concurrent users
 CSIHOLD - SMP/E CSI hold data
 CSIORDER - SMP/E CSI receive orders
 CSIPROD - SMP/E CSI products
 CSIQUERY - SMP/E CSI query
 CSIT - CICS system initialization table
 CSITINIT - CICS initialization parms
 CSMBUFF - CSM global buffer pool
 CSMOWNER - CSM global storage owners
 CSMSTAT - Communications storage manager
 CSOCKETS - CICS sockets
 CSRT - CICS system recovery table
 CSTATUS - CICS resource status summary
 CSUBPOOL - CICS dynamic storage subpools
 CSUBSPAC - CICS subspace areas
 CSYMBOLS - CICS symbols
 CSYSDATA - CICS system interval analysis
 CSYSDMON - CICS system data monitor
 CTAGS - CICS region tagging
 CTASKENT - CICS kernel task table entries
 CTASKS - CICS active tasks
 CTCBMODE - CICS TCB modes
 CTCBPOOL - CICS TCB pools
 CTCLASS - CICS transaction classes
 CTDATA - CICS transient data queues
 CTDSTATS - CICS transient data statistics
 CTEMPSTG - CICS temporary storage summary
 CTERMS - CICS terminal statistics
 CTGLIST - CICS Transaction Gateway list
 CTGLOG - CICS Transaction Gateway log
 CTGLSRVR - CTG logical server connections
 CTGSET - Set CTG options
 CTGSRVR - CTG CICS server connections
 CTGWEBSV - CTG web services
 CTIMERS - CICS interval timers
 CTOGGLES - CICS feature toggles
 CTRACE - CICS trace table
 CTRANCAN - CICS transaction cancel defs
 CTRANDEG - CICS transaction degradation
 CTRANLOG - CICS transaction log summary
 CTRANOPT - CICS transaction options
 CTRANS - CICS transaction summary
 CTRANSUM - CICS transaction intervals
 CTSDSTAT - Time Series Data statistics
 CTSMODEL - CICS temporary storage models
 CTSPOOLS - CICS temporary storage pools
 CTSQUEUE - CICS temporary storage queues
 CUOW - CICS units of work
 CURIMAPS - CICS URI maps
 CURSOR - Move cursor to command line
 CUSERS - CICS external security user info
 CVLIST - Symbolic variable list
 CWAITS - CICS degradation wait analysis
 CWEBSERV - CICS web services
 CWLMHLTH - CICS WLM Health
 CXDISTAT - External data interface stats
 DASD - DASD units
 DASDRESP - DASD response time
 DAT - Control DAT mode
 DATACOM - Set target Datacom job
 DATE - Query current date and time
 DBBPOOLS - DB2 buffer pools
 DBDSETS - DB2 open datasets
 DBERRMSG - DB2 Error message
 DBLOGAL - DB2 log allocation
 DBLOGCKP - DB2 log checkpoint
 DBPRMBP - DB2 buffer pool parms
 DBPRMGBP - DB2 group buffer pool parms
 DBPRMS - DB2 system parameters
 DBSQLDY - DB2 SQL dynamic cache
 DBSTG - DB2 storage utilization stats
 DBSYSSUM - Db2 system summary
 DBTHACT - DB2 active threads
 DBTHCONT - Db2 active thread contentions
 DB2 - Set target DB2 subsystem
 DB2LIST - DB2 subsystem list
 DCACAREA - Datacom MUF access areas
 DCACCESS - Datacom MUF access
 DCACNT - Datacom MUF accounting
 DCAREAIO - Datacom MUF area stats
 DCAREAS - Datacom directory areas
 DCBUFCON - Datacom MUF buffer pool contents
 DCBUFFER - Datacom MUF buffers
 DCBUFP - Datacom MUF buffer pool stats
 DCCBS - Datacom MUF CBS info and stats
 DCCBSO - Datacom MUF CBS old sets info
 DCCDC - Datacom MUF CDC information
 DCCDCBT - Datacom MUF CDC base table info
 DCCDCL - Datacom MUF CDC listener info
 DCCOLUMN - Datacom directory columns
 DCCONFIG - Datacom config commands
 DCDATASH - Datacom MUF data sharing
 DCDBASES - Datacom directory databases
 DCDIR - Datacom directories
 DCDSETS - Datacom directory data sets
 DCDUMPL - Datacom MUF dumps previous
 DCDUMPS - Datacom MUF dumps
 DCELEMEN - Datacom directory elements
 DCINDEX - Datacom directory indexes
 DCKEYFLD - Datacom directory key fields
 DCKEYS - Datacom directory keys
 DCLIST - List monitored Datacom jobs
 DCLOCKS - Datacom MUF Locks information
 DCLOG - Datacom MUF logging
 DCMEMDT - Datacom MUF memory pool detail
 DCMEMSM - Datacom MUF memory pool summary
 DCMRDF - Datacom MUF MRDF
 DCMUFS - Datacom MUF identity
 DCOPEN - Datacom MUF open bases
 DCOPTION - Datacom MUF options
 DCPARCOL - Datacom directory partition cols
 DCPRODS - Datacom MUF products
 DCRATES - Datacom MUF rates
 DCRCOPT - Datacom MUF return code info
 DCREQS - Datacom MUF requests
 DCRETCOD - Datacom MUF return codes
 DCSMP - Datacom MUF SMP stats
 DCSMPTSK - Datacom MUF SMP tasks
 DCSQLCOD - Datacom MUF SQL codes
 DCSQLMSC - Datacom MUF SQL misc stats
 DCSQLPRC - Datacom MUF SQL procedure detail
 DCSQLSEQ - Datacom MUF SQL sequence number
 DCSTATS - Datacom MUF internal stats
 DCSTATSM - Datacom MUF misc internal stats
 DCSYSOUT - Datacom MUF Sysout information
 DCSYSTEM - Datacom MUF system stats
 DCTABLES - Datacom directory tables
 DCTABREQ - Datacom MUF table stats
 DCTASKS - Datacom MUF active tasks
 DCTCBSRB - Datacom MUF TCB/SRB use stats
 DCTRACE - Datacom request trace table
 DCTRACEB - Datacom buffer trace table
 DCVOLUME - Datacom directory volumes
 DCXCF - Datacom MUF XCF
 DCZIIP - Datacom MUF SRB/ZIIP statistics
 DDLIST - Display and search ddname libs
 DELAYS - Job degradation delay analysis
 DELMAPS - Delete loaded maps
 DEST - Set destination filter
 DETAILS - Command detail reports
 DEVPATH - Device paths
 DISASSEM - Disassemble in-storage modules
 DLDELETE - DATALIB delete
 DLEXPORT - DATALIB export
 DLIMPORT - DATALIB import
 DLINIT - DATALIB init
 DLLIST - DATALIB list
 DLOPTION - DATALIB options
 DLVIEW - DATALIB view
 DOWN - Scroll down
 DROP - Drop equated symbol
 DSALLOC - Data sets allocated to a job
 DSCAT - Cataloged data sets
 DSID - Change target data space
 DSINFO - Data set information
 DSLIST - Data spaces
 DSMFLOGS - Dynamic SMF log streams
 DSMFSET - Dynamic SMF set
 DUMP - Display virtual and real storage
 DUMPDS - Dump data sets
 DUMPINFO - Show info from a dump data set
 DUMPOPTS - Dump options
 DYNEXIT - Dynamic exits
 ECHO - Echo command parms in message
 ECONFLIC - Enhanced enqueue conflicts
 EDIT - Edit data with ISPF EDIT
 EDT - Eligible device table
 EDTSUMM - Eligible device table summary
 END - Terminate product session
 ENFLIST - Event notification facility
 ENQDSN - Enqueued data sets
 ENQEDIT - Enqueues by ISPF edit
 ENQJOB - Enqueues for job
 ENQSTATS - Enqueue statistics
 ENQSUM - Enqueue summary
 ENQUEUE - Enqueue detail
 EQUATE - Equate symbol to address
 ESCAPE - Immediate product exit
 ESRTABLE - Extended SVC router table
 ETCONN - Entry table connections
 ETLIST - Entry table entries
 ETRINFO - External time reference info
 EXTENTS - Volume extents
 EXTRACT - Extract profile values
 FEATURES - Feature definitions
 FIELDS - Field definitions
 FILL - Fill input fields with data
 FIND - Find string in display data
 FINDHELP - Search online knowledge base
 FLUSH - Flush pending input or levels
 FORMATS - List command formats
 FRAMES - Real storage frames
 FREEGCOM - Free allocated grande common
 FREEMAIN - Free allocated common storage
 FTPCA - FTP data set to Support
 FXE - IBM Function Registry for z/OS
 GCOMMON - Common storage above 2G
 GETMAIN - Allocate common storage
 GPRIVATE - Private storage above 2G
 GRAPH - Graph data metrics
 GROUPS - Logical groups
 HCCLIST - Health checker command list
 HCCMD - Health checker command
 HCHECKER - Health checker
 HCLOG - Health checker log
 HCMSGS - Health checker messages
 HCOWNER - Health checker owner summary
 HELP - Display help information
 HELPLIB - HELPLIB libraries
 HEX - Control display of hex lines
 HSMREQ - HSM request status
 HWIDISC - Disconnect BCPii tokens
 ICSF - ICSF services
 IDBUFFIO - IDMS buffer I/O
 IDB2 - SYSVIEW for DB2
 IDCAMS - IDCAMS command facility
 IDDBASES - IDMS database overview
 IDDBIOD - IDMS database I/O drivers
 IDENTIFY - Identify address as a module
 IDJRNL - IDMS journal activity
 IDLINES - IDMS communication lines
 IDLTERMS - IDMS logical terminals
 IDLTRESU - IDMS logical terminal rsce usage
 IDMS - Set target IDMS
 IDMSLIST - IDMS address space list
 IDMSSET - Alter IDMS resources
 IDPGMPL - IDMS program pools
 IDRU - IDMS system run units
 IDSCRMGR - IDMS scratch manager
 IDSQL - IDMS SQL usage
 IDSTG - IDMS storage pool overview
 IDSTGPL - IDMS storage pools
 IDTASKS - IDMS active tasks
 IDTRANOV - IDMS transaction overview
 IDTRANS - IDMS transactions
 IDTSKPGM - IDMS task/program pool overview
 IMAGES - Images
 IMS - Set target IMS control region
 IMSALERT - IMS exception alerts
 IMSBALG - IMS balance groups
 IMSBUFP - IMS buffer pools
 IMSCLASS - IMS classes
 IMSCMD - IMS command utility
 IMSCONN - IMS Connect connections
 IMSDAILY - IMS daily usage
 IMSDATA - Set IMS data collection options
 IMSDBASE - IMS databases
 IMSDBLS - IMS database logical structure
 IMSDBPS - IMS database physical structure
 IMSDCMON - IMS DC monitor subsystem
 IMSDEDB - IMS DEDB DBRC DB-DBDS query
 IMSDESS - IMS dependent region ESS
 IMSDLIDB - IMS DL/I DBRC DB-DBDS query
 IMSEVENT - IMS monitor events status
 IMSFDBR - IMS FDBR regions
 IMSHALDB - IMS HALDB DBRC DB-DBDS query
 IMSHSB - IMS hot standby systems
 IMSLATCH - IMS latch contention
 IMSLINES - IMS lines
 IMSLIST - IMS control regions
 IMSLOCKS - IMS IRLM locks
 IMSLTERM - IMS logical terminals
 IMSMSGQ - IMS message queues
 IMSMTO - IMS master terminal
 IMSNODES - IMS nodes
 IMSOMAT - IMS OM audit trail
 IMSOMAX - IMS OM audit response record
 IMSOSAM - IMS OSAM subpool statistics
 IMSOSUM - IMS OSAM subpool summary
 IMSOTMA - IMS OTMA status
 IMSOVER - IMS overview
 IMSPI - IMS program isolation statistics
 IMSPOOLS - IMS pools
 IMSPROGS - IMS program directory
 IMSPSBS - IMS program specification blocks
 IMSQPOOL - IMS queue pool statistics
 IMSQSTAT - IMS shared queue statistics
 IMSQSUM - IMS shared queue count summary
 IMSQTRAN - IMS shared queue transactions
 IMSRACT - IMS dependent region detail
 IMSREGNS - IMS dependent regions
 IMSRSLOG - IMS region summary log
 IMSSET - Perform actions on IMS resources
 IMSSLOGS - IMS system logs status
 IMSSPOC - IMS Single Point of Control
 IMSSSYS - IMS external subsystems
 IMSTEXIT - IMS exit trace
 IMSTIMES - IMS transaction times
 IMSTLIST - IMS trace list
 IMSTLOG - IMS transaction log
 IMSTRACE - IMS monitor trace
 IMSTRANS - IMS transaction codes
 IMSTSUM - IMS transaction summary
 IMSTTABL - IMS table trace
 IMSUEXIT - IMS user exits
 IMSUSERS - IMS users
 IMSVSAM - IMS VSAM subpool statistics
 IMSVSUM - IMS VSAM subpool summary
 IMSWAITS - IMS wait analysis
 INFOFLDS - List info line fields defined
 INFOLEFT - Scroll info lines left
 INFORIGH - Scroll info lines right
 INVOKE - Invoke external applications
 IOCDATA - I/O configuration data
 IPCONFIG - IP configuration
 IPDEVICE - TCP devices/links/interfaces
 IPEECONN - Enterprise Extender connections
 IPEESUM - Enterprise Extender summary
 IPLINFO - IPL information
 IPLISTEN - TCP listeners
 IPLSTATS - IPL statistics
 IPPORTS - Reserved ports
 IPSTATS - Performance statistics
 IPTCONN - TCP socket connections
 IPTELNET - TELNET sessions
 IPUCONN - UDP socket connections
 IPUSERS - TCP/UDP users
 IRLMLIST - IRLM list
 IRLMLOCK - IRLM locks
 ISERVE - GSS ISERVE command facility
 ISPFCMD - Execute any ISPF command
 ISPTCM - ISPF TSO command table
 JAPPL - JES2 applications
 JBROWSE - JES job output using ISPF BROWSE
 JCGROUPS - JES3 job class groups
 JCKPT - JES2 checkpoint information
 JCOPYOUT - Copy JES output
 JCPU - JES2 main task CPU statistics
 JDESTID - JES2 destination IDs
 JEDIT - JES job output using ISPF EDIT
 JESSET - Alter JES resources
 JHELDQUE - JES held output queue
 JINIT - JES initiators
 JINPRTY - JES input job priority summary
 JINTRDR - JES2 internal readers
 JJCL - JES job JCL using ISPF EDIT
 JJOBDEP - JES job dependencies
 JJOBGRP - JES job groups
 JJOBQUE - JES job queues
 JLINES - JES NJE and RJE lines
 JLOGON - JES2 LOGON devices
 JNETSERV - JES network servers
 JNODES - JES nodes
 JOBCARD - Display and edit JOB card
 JOBCLASS - Job classes
 JOBSUM - JES job summary
 JOFFLOAD - JES2 offloaders
 JOUTCLAS - JES2 output classes
 JOUTDES - Output descriptors
 JOUTPUTW - JES job output
 JOUTQUE - JES output queue
 JPA - Job pack area modules
 JPATHS - JES2 network paths
 JPLEX - JES members
 JPRINTER - JES printers
 JPUNCH - JES punches
 JREADER - JES readers
 JREMOTES - JES remote devices
 JRESOURC - JES2 resources
 JSESSION - JES2 sessions
 JSOCKET - JES sockets
 JSPOOLS - JES spool volumes
 JSTORAGE - JES2 storage usage
 JSYSLOGW - JES system log
 JTRANQUE - JES transaction output queue
 JVMALERT - JVM exception alerts
 JVMARGS - JVM arguments
 JVMBEANS - JVM management beans
 JVMCPU - JVM CPU
 JVMDATA - Set JVM data collection options
 JVMDMODS - JVM data collection modules
 JVMDMON - JVM data collection monitor
 JVMDTHDS - JVM data collection threads
 JVMDUMPO - JVM dump options
 JVMGC - JVM garbage collection
 JVMHEAPS - JVM heaps
 JVMLIST - Java virtual machine list
 JVMMMGR - JVM memory manager
 JVMPATHS - JVM paths
 JVMPROP - JVM properties
 JVMSET - Set JVM data collector options
 JVMSTACK - JVM stack trace
 JVMTHRDS - JVM threads
 JVMVERS - JVM versions
 JVMXDIS - JVM external data interface stat
 KEYRINGS - Keyrings and certificates
 KEYS - ISPF KEYS command
 LABEL - Assign label to current line
 LATCHES - Latches
 LCASSIST - Line command assist
 LEENVAR - LE environment variables
 LEFT - Scroll left
 LEHEAPS - LE heaps
 LENGTHS - Display field length data
 LEOPTS - LE run time options
 LEPATHS - LE paths
 LGBROWSE - Log stream browser
 LGCONN - Log stream connections
 LGDRO - Log stream delete records older
 LGEMPTY - Empty a log stream
 LGJOBS - Job log stream connections
 LGLOGS - Data logs
 LGOFFLOD - Initiate log stream offload
 LGOPTION - Set logger command options
 LGPLEX - Sysplex log stream connections
 LGSTAGE - Logger staging data sets
 LGSTREAM - Log stream definitions
 LGSTRUCT - Log stream structure definitions
 LIBCACHE - Library cache
 LIBS - Product libraries
 LIBVIEW - Library viewer
 LINECMD - Enter line commands
 LINK - Link to another command
 LINKACT - Activate dynamic linklist set
 LINKALOC - Allocate dynamic linklist libs
 LINKDEF - Define dynamic linklist set
 LINKDEL - Delete dynamic linklist set
 LINKFREE - Unallocate dynamic linklist libs
 LINKJOBS - Dynamic linklist set jobs
 LINKLIBS - Dynamic linklist set libraries
 LINKLIST - LINKLIST data sets
 LINKOPT - Set dynamic linklist cmd options
 LINKSETS - Dynamic linklist sets
 LINKUPD - Update job dynamic linklist sets
 LISTCONS - List consoles
 LISTCSEL - List cursor selection info areas
 LISTDIR - List PDS directory
 LISTDSPS - List dataspaces
 LISTFILE - JES job data sets
 LISTINP - JES job input queue
 LISTLAB - List defined labels
 LISTLCMD - List line commands
 LISTLOAD - Loaded modules
 LISTLOG - Activity log
 LISTMAPS - List storage maps loaded
 LISTMDIR - List multiple directories
 LISTMENU - MENU definitions
 LISTMODS - Product module status
 LISTMORE - More information command list
 LISTSEL - List current SELECT status
 LISTUCMD - List external user commands
 LLAREFR - Selective LLA refresh
 LLASTATS - LLA statistics
 LMINFO - Load module information
 LOADMAPS - Load DSECT storage maps
 LOCATE - Locate display line or label
 LOGREC - LOGREC event history
 LONGCMD - Display long command input field
 LOOKUP - Lookup command or subcommand
 LPA - Link pack area modules
 LPALIST - LPALIST data sets
 LSRBUFF - Local shared resource buffers
 LSRPOOLS - Local shared resource pools
 LXATABLE - Linkage index allocation table
 MAP - Map storage
 MAPLIB - MAPLIB libraries
 MASTER - Issue command to master console
 MENU - Display menu
 METRICS - Data collection metrics
 METSET - Set metric attributes
 MIATAPES - MIA tapes
 MIIQCNTS - MII qname counts
 MIIQSERV - MII qname service
 MIMFAC - MIM facilities
 MIMLIST - MIM list
 MIMOPTS - Set MIM command options
 MIMSYS - MIM systems
 MOBJECTS - Memory objects summary
 MODIDR - Module IDR records
 MODIDS - Module ID analysis
 MODIFY - Modify SET keyword values
 MODMAP - Module maps
 MODULES - Modules
 MODXREF - Module cross references
 MONRULES - Monitor rules
 MOREINFO - More detailed information
 MPFTABLE - Message process facility table
 MQACTIVE - MQ active threads
 MQALERTS - MQ exception alerts
 MQALTER - MQ alter objects
 MQAUTHIN - MQ authentication objects
 MQBROWSE - MQ browse queue contents
 MQBUFFER - MQ buffer statistics
 MQCFBACK - MQ CF backup status
 MQCFCONN - MQ CF connection status
 MQCFSMCO - MQ CF SMDS connections
 MQCFSMDS - MQ CF SMDS status
 MQCFSTRU - MQ CF structures
 MQCFSUMM - MQ CF summary status
 MQCHAN - MQ channel definitions
 MQCHAUTH - MQ channel authentications
 MQCHCCON - MQ client connect channels
 MQCHCRCV - MQ cluster receiver channels
 MQCHCSND - MQ cluster sender channels
 MQCHRCVR - MQ receiver channels
 MQCHRQSR - MQ requester channels
 MQCHSCON - MQ server connect channels
 MQCHSNDR - MQ sender channels
 MQCHSRVR - MQ server channels
 MQCHSTAT - MQ channel status
 MQCHSUMM - MQ channel status summary
 MQCLEAN - MQ cleanup service
 MQCLEAR - MQ clear local queue
 MQCMD - MQ command utility
 MQCONN - MQ connect service
 MQCQMGR - MQ cluster queue managers
 MQDB2ACT - MQ DB2 manager activity
 MQDB2SRV - MQ DB2 server tasks
 MQDEAD - MQ view dead letter queue
 MQDEFINE - MQ define object
 MQDISC - MQ disconnect service
 MQDQMGR - MQ distributed queue mgr
 MQEDIT - MQ edit queue contents
 MQEVENT - MQ view event queues
 MQHANDLE - MQ handles
 MQINDOUT - MQ indoubt threads
 MQLGMGR - MQ log manager
 MQLGSTAT - MQ log manager statistics
 MQLIST - MQ subsystem list
 MQLOGS - MQ active logs
 MQMGR - MQ queue manager
 MQMSGLOG - MQ message log
 MQNAME - MQ name lists
 MQPAGE - MQ page sets
 MQPARMS - MQ parameter settings
 MQPERF - MQ performance statistics
 MQPROC - MQ processes
 MQPUBSUB - MQ Pub/Sub status
 MQQALIAS - MQ alias queues
 MQQCLUST - MQ cluster queues
 MQQLOCAL - MQ local queues
 MQQMODEL - MQ model queues
 MQQMOVE - MQ move queue
 MQQPERF - MQ queue performance
 MQQREMOT - MQ remote queues
 MQQSTAT - MQ queue status
 MQQUEUE - MQ queues
 MQQUSERS - MQ queue users
 MQQUTIL - MQ queue import/export utility
 MQRCONF - MQ request monitor configuration
 MQRJOB - MQ request history by job
 MQRLOG - MQ request history log
 MQROBJ - MQ request history by object
 MQRSTAT - MQ request monitor status
 MQRSUMM - MQ request summary
 MQRTRACE - MQ request trace
 MQSBSTAT - MQ subscription status
 MQSDATA - Set MQ data collection options
 MQSECUR - MQ security
 MQSERIES - Set target local MQ qmgr
 MQSSET - Perform actions on MQ objects
 MQSTGCL - MQ storage classes
 MQSUBSCR - MQ subscriptions
 MQTOPIC - MQ administrative topic objects
 MQTRACE - MQ traces
 MQTUSERS - MQ topic users
 MQUSERS - MQ users
 MSGCOLOR - Message color and highlight attr
 MSGPARMS - Message parameters
 MTT - Master trace table
 MVS - Issue MVS operator command
 MVSDATA - Set MVS data collection options
 NAMETOKN - Name/token pairs
 NOOP - No operation
 NUCLEUS - Nucleus modules
 NULL - Null display
 OPCODES - Assembler opcodes
 OPERLOG - Operations log
 OUTPUT - JES job output
 OVERCMDS - Overview capable commands
 OWNER - Set owner filter
 PAGEDS - Page data sets
 PAGES - Virtual storage pages
 PAGING - System paging
 PANELLIB - PANELLIB libraries
 PARMLIB - Product PARMLIB libraries
 PARMLIST - System PARMLIB libraries
 PARTINFO - Partition information
 PAUSE - Pause for an interval of time
 PCIE - PCIe information
 PCLIST - PC routines
 PETS - Pause element tokens
 PFSHOW - Control display of PFK lines
 PFT - Page frame table
 PING - Ping remote host
 PLEXARM - Sysplex auto restart manager
 PLEXCPL - Sysplex couple data sets
 PLEXGRPS - Sysplex groups
 PLEXMBRS - Sysplex members
 PLEXPATH - Sysplex paths
 PLEXPEND - Sysplex pending messages
 PLEXSYS - Sysplex systems
 PLOT - Plot historical data
 PLOTATTR - Plot field attributes
 PLOTLIB - PLOTLIB libraries
 PLOTLIST - Plot selection list
 PLOTLOG - Historical plot log
 POINFO - Program object information
 POSTEXIT - Post exit routines
 PPT - Program properties table
 PREFIX - Set jobname filter
 PRINT - Print display lines
 PRISM - PR/SM and LPAR information
 PRIVATE - Private area storage usage
 PROCINFO - Processor information
 PROCLIST - JES procedure libraries
 PRODLIFE - Product lifecycle
 PRODUCTS - External applications
 PROFILE - Profile - command processor
 PROFLIST - Profile fields list
 PROFMBRS - Profile members
 PROMPT - Place prompt in command field
 PROMPTNM - Command prompt, not modified
 PSW - Program status word decoded
 PTFCVSS - PTF SECINT CVSS Information
 PTFLIST - PTF analysis product list
 PTFS - Product PTFS
 PVTUSAGE - Private storage usage
 QLIST - Quick list commands
 QUERY - Query profile values
 QUICKREF - MVS/QuickRef from Chicago-Soft
 RECALL - Recall last command
 REGION - Virtual storage regions
 REGPRODS - Registered products
 REPEAT - Repeat last command
 RESERVE - Reserved DASD devices
 RESET - Reset command parameters
 RESMGRS - Resource managers
 RETURN - Return to previous display
 REVIEW - Review command input stack
 REXXLIB - REXXLIB libraries
 RIGHT - Scroll right
 RMCAP - RMF CPC system information
 RMCDEV - RMF cache device data
 RMCFSTRU - RMF coupling facility structures
 RMCFSUMM - RMF coupling facility summary
 RMCFUSER - RMF coupling facility users
 RMCHAN - RMF channel path activity
 RMCRYACC - RMF crypto accelerator activity
 RMCRYOVW - RMF crypto hardware overview
 RMCRYPKC - RMF crypto PKCS11 activity
 RMDASD - RMF DASD data
 RMEADM - RMF Extended asynch data mover
 RMFSLIST - RMF zFS file system information
 RMFSSTAT - RMF zFS System Statistics
 RMINDEX - RMF dataset index information
 RMJOBS - RMF job information
 RMJSTAT - RMF job state delay analysis
 RMMSU - RMF CPC system detail
 RMORPHAN - RMF orphaned storage info
 RMPCIE - RMF PCIE function information
 RMPROC - RMF CPC processor information
 RMRESP - RMF WLM response time data
 RMSTG - RMF storage information
 RMSYSSUM - RMF WLM system summary data
 RMUSSP - RMF USS process data
 RNLIST - GRS resource name lists
 ROSACT - ROSCOE activity
 ROSAWS - ROSCOE AWS data sets
 ROSBUFF - ROSCOE buffer usage
 ROSCOE - Set target ROSCOE address space
 ROSLIBS - ROSCOE libraries
 ROSLIST - List monitored ROSCOE jobs
 ROSMON - ROSCOE monitor routines
 ROSMPL - ROSCOE MPL stack usage
 ROSRESP - ROSCOE response times
 ROSRESPD - ROSCOE response time summary
 ROSUSERS - ROSCOE user status
 ROWDISP - Row display
 RULES - Exception rules
 RXCLIST - Execute REXX command list
 RXDISP - Execute REXX EXEC and disp resps
 RXEXEC - Execute a REXX EXEC
 RXINIT - Initialize a REXX environment
 RXOUTPUT - Display REXX output
 RXQUERY - Query REXX environment name
 RXTERM - Terminate a REXX environment
 SAFAUTH - SAF authorizations
 SAMPLIB - SAMPLIB libraries
 SCHEDULE - Scheduled events
 SCM - System condition monitor
 SCMENTRY - System condition monitor detail
 SCMMSG - System condition monitor msgs
 SCMSYS - System condition monitor system
 SCREEN - Screen field attributes
 SECURITY - Security - administration
 SEGMENTS - Virtual storage segments
 SELECT - Set field selection criteria
 SENDMAIL - Send simple text email
 SENDTRAP - Send SNMP alert trap
 SET - Change various option settings
 SFTABLE - System function table
 SLIPS - Slip traps
 SMF - SMF data sets
 SMFDATA - SMF data collection
 SMFDROP - SMF dropped records history
 SMFFLOOD - SMF flood policies
 SMFINMEM - SMF In-Memory resources
 SMFLIM - SMFLIM definitions
 SMFLOG - SMF log
 SMFRPT - SMF record report
 SMFTYPE - SMF record type definitions
 SMSAGGRG - SMS aggregate groups
 SMSCLOUD - SMS clouds
 SMSDATA - SMS data classes
 SMSGROUP - SMS storage groups
 SMSINFO - SMS configuration information
 SMSMGMT - SMS management classes
 SMSSTOR - SMS storage classes
 SMSVOLS - SMS volumes
 SNAP - Snap dump real/virtual storage
 SOBJECTS - Shared memory objects
 SOFTWARE - Software versions
 SORT - Sort display data lines
 SPACE - DASD free space
 SPLIT - ISPF SPLIT command
 SRBS - Service request blocks
 STACK - Add command to stack
 STATUS - Product status
 STCK - Format or convert STCK time
 STEPSUM - JES step summary
 STORAGE - System storage
 STREXCL - Structure exclusion lists
 STRLIST - Structure summary
 STRPREF - Structure preference lists
 SUBCHAN - Subchannels
 SUBMIT - Submit JCL for execution
 SUBPOOL - Storage subpool information
 SUBSYS - Subsystem information
 SVCTABLE - SVC table
 SWAP - ISPF SWAP command
 SWAPPING - System swapping
 SYMBOLS - Symbol table
 SYMPTOMS - DAE symptom records
 SYSDMON - System data collection monitor
 SYSGROUP - System groups
 SYSLOG - System log
 SYSSYM - Static system symbols
 SYSTEMS - Systems overview
 SYSVIEW - Product primary option menu
 TAPE - Tape units
 TASK - Task structure
 TASKLIB - TASKLIB/STEPLIB/JOBLIB libraries
 TASKMON - Task monitor
 TCPALERT - TCP/IP exception alerts
 TCPDATA - Set TCP data collection options
 TCPLIST - TCP/IP Images
 TCPOPTS - Set TCP/IP options
 TEMPLATE - TEMPLATE libraries
 TERMINAL - Call ISPF terminal option (0.1)
 TIME - Query current time and date
 TIMERS - Timer intervals and exits
 TIMEZONE - Time zones
 TOP - Scroll to top of display
 TOPICS - Help topic knowledge base
 TOTAL - Total display column data
 TRACE - System trace table
 TRSETS - Translation table sets
 TRTABLES - Translation tables
 TSDSTATS - Time Series Data statistics
 TSO - Execute TSO commands or CLISTs
 TSOSET - TSO environment settings
 TSOTABLE - TSO tables
 TYPE - Type data on virtual screen
 UDIRTREE - USS directory tree structure
 UFILES - USS open files
 UFILESYS - USS mounted file systems
 UFSMNT - Mount Unix File System
 UFSUMNT - Unmount Unix File System
 UGROUPS - USS groups
 UKILL - USS kill a process
 ULISTDIR - USS list directory entries
 UMSGQUE - USS IPC message queues
 UNIT - Units
 UP - Scroll up
 UPDATE - Control automatic update mode
 UPROCESS - USS processes
 URESOURC - USS resource monitor data
 USE - Associate a symbol with a map
 USEMAPH - USS IPC semaphores
 USERACT - User logon activity
 USERCMD - Issue user command
 USERS - Product users
 USHRMEM - USS IPC shared memory
 USIGNAL - USS send a signal to a process
 USS - USS set target ASID
 USSCMD - USS commands
 USSLIST - USS list address spaces
 USYSCONF - USS system configuration options
 UTHREADS - USS threads
 UUSERS - USS users
 VALPATH - Validate I/O path
 VCHECK - Check variables passed to CLIST
 VDEFAULT - Set default CLIST variables
 VDEFINE - Define a user variable
 VDELETE - Delete a user variable
 VIEW - View data with ISPF VIEW
 VLFIELD - Control variable length fields
 VLFLIST - List variable length fields
 VLIST - List user and system variables
 VM - VM command facility
 VOLMAP - Volume map
 VRESET - Delete all user variables
 VSAM - VSAM file performance
 VSET - Set user variable to a value
 VSMTRACK - VSM common storage tracking
 VTAM - VTAM operator facility
 VTOC - Volume table of contents
 WAIT - Wait for a time interval
 WEBS - Work element blocks
 WLM - WLM definition tree
 WLMOPTS - Set WLM command options
 WLPAPPS - WAS Liberty applications
 WLPCONNP - WAS Liberty connection pools
 WLPENDPT - WAS Liberty endpoints
 WLPLIST - WAS Liberty server list
 WLPSERVL - WAS Liberty servlets
 WLPSESS - WAS Liberty sessions
 WLPSET - Set WAS Liberty server options
 WMACT - WLM workload activity
 WMADELAY - WLM address space delay
 WMAGRAPH - WLM address space delay graph
 WMAPPENV - WLM application environments
 WMASINFO - WLM address space information
 WMCLASS - WLM policy service class defs
 WMDELAY - WLM workload activity delay
 WMDIST - WLM response time distribution
 WMENCLAV - WLM enclave information
 WMGROUPS - WLM group rules
 WMOPTS - WLM option settings
 WMPOLICY - WLM service policy
 WMREPORT - WLM report class definitions
 WMRESP - WLM activity response time
 WMRSCE - WLM resource group definitions
 WMSCHENV - WLM scheduling environment
 WMSERSCE - WLM schenv resource entries
 WMSUBSYS - WLM subsystem rules
 WMSYSCAP - WLM system capacity information
 WMSYSSUM - WLM system summary
 WMTENANT - WLM tenant resource groups
 WMWORK - WLM policy workload definitions
 WORKLOAD - Workload summarization
 WTOACTN - WTO action messages
 WTOR - WTO reply required messages
 XCFADMIN - Sysplex admin utility interface
 XCONSOLE - Extended console
 XLOG - Exception log
 XMLLIB - XMLLIB libraries
 XMVS - Issue command and view responses
 XSCMDS - XSystem capable commands
 XSCONN - XSystem connect
 XSLIST - XSystem list
 XSMVS - XSystem MVS command
 XSPING - XSystem ping
 XSSTATUS - XSystem status
 XSUSER - XSystem users
 XTSO - Issue TSO cmd and display resps
 XVEXTRAC - External variable extract
 XVLIST - External variable list
 ZAP - Display and alter DASD records
 ZCNAPIS - z/OS Connect APIs
 ZCNLIST - z/OS Connect server list
 ZCNRLOG - z/OS Connect request log
 ZCNSERV - z/OS Connect services
 ZCNSET - Set z/OS Connect server options
 ZCNSOR - z/OS Connect Systems of Record
 ZCNURIS - z/OS Connect URIs
 ZCXCPU - z/OS Container Extensions CPU
 ZCXDISK - z/OS Container Extensions disks
 ZCXLIST - z/OS Container Extensions list
 ZDMSET - Set zData Mover attributes
 ZDMSTATS - zData Mover statistics
 ZEDC - zEDC Information
ABENDX

ABENDX Command

The ABENDX command displays the abend recovery environments


that have been established in an address space.

Command Syntax

+---------------+------------------------------------------------------------+
| ABENDX | [asid] |
+---------------+------------------------------------------------------------+

Parameters

+----------------+-----------------------------------------------------------+
| Parameter | Explanation |
+----------------+-----------------------------------------------------------+
| asid | The ASID of the target address space. For details on |
| | specifying an ASID parameter, see the ASID command. If |
| | the ASID parameter is omitted, then the current ASID is |
| | used. |
+----------------+-----------------------------------------------------------+

Information Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Jobname | The jobname of the current address space. |
+---------------+------------------------------------------------------------+
| ASID | The address space ID. |
+---------------+------------------------------------------------------------+
| Jobid | The job identifier. |
+---------------+------------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| TCB | The address of the TCB covered by the abend exit. |
+---------------+------------------------------------------------------------+
| OwnTCB | The address of the TCB that owns ESTAI/STAI. |
+---------------+------------------------------------------------------------+
| OwnRB | The address of the RB that owns ESTAE/STAE. |
+---------------+------------------------------------------------------------+
| Type | The type of abend exit. Valid values are: |
| | |
| | ESTAEX |
| | ESTAE |
| | STAE |
| | ESTAI |
| | STAI |
| | ESPIE |
| | SPIE |
| | |
+---------------+------------------------------------------------------------+
| Exit | The entry point address of the abend exit routine. |
+---------------+------------------------------------------------------------+
| Region | The name of the region where the exit is located. |
+---------------+------------------------------------------------------------+
| Module | The module name of the exit. |
+---------------+------------------------------------------------------------+
| Offset | Offset into the module of the exit address. |
+---------------+------------------------------------------------------------+
| Parm | The parameter to be passed to the exit. |
+---------------+------------------------------------------------------------+
| ALET | The ALET for the parameter to be passed to the exit. |
+---------------+------------------------------------------------------------+
| Token | The token associated with the exit. |
+---------------+------------------------------------------------------------+
| Asynch | This value is ASYNCH if the macro that specified the exit |
| | has ASYNCH=YES. Otherwise, it is blank. |
+---------------+------------------------------------------------------------+
| Purge | The active I/O purge option. Valid values are: |
| | |
| | NONE I/O is not to be disturbed |
| | QUIES Active I/O is to be quiesced |
| | HALT Active I/O is to be halted |
| | |
+---------------+------------------------------------------------------------+
| Term | This value is TERM if the macro that specified the exit |
| | has TERM=YES. Otherwise, it is blank. |
+---------------+------------------------------------------------------------+
| Xctl | This value is XCTL if the macro that specified the exit |
| | has XCTL=YES. Otherwise, it is blank. |
+---------------+------------------------------------------------------------+
| AM | The exit addressing mode. Values are 24, 31, and 64. |
+---------------+------------------------------------------------------------+
| State | The exit entrance state. Valid values are SUP, if |
| | supervisor state, and PROB, if problem state. |
+---------------+------------------------------------------------------------+
| Key | The exit entrance key. |
+---------------+------------------------------------------------------------+
| ASC | The exit address space control mode. Values are PRI |
| | (primary) and AR (access register). |
+---------------+------------------------------------------------------------+
| Cancel | This value is CANCEL if the macro that specified the exit |
| | has CANCEL=YES. Otherwise, it is blank. |
+---------------+------------------------------------------------------------+
| Record | This value is RECORD if the macro that specified the exit |
| | has RECORD=YES. Otherwise, it is blank. |
+---------------+------------------------------------------------------------+
| SpieOv | This value is SPIEOV if the macro that specified the exit |
| | has SPIEOVERRIDE=YES. Otherwise, it is blank. |
+---------------+------------------------------------------------------------+
| Interrupts | The list of interrupt codes to cause exit entry. This is |
| | valid only for types ESPIE and SPIE. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. |
+---------------+------------------------------------------------------------+
ACTIVITY

ACTIVITY Command

The ACTIVITY command displays the status of jobs executing


in the system. A job can be a started task, a TSO user, or
a batch job. With the information displayed by the ACTIVITY
command, you can determine the following:

* Whether a job is swapped out and why it is swapped out

* The amount of real storage a job is using

* The dispatching priority of a job relative to other jobs

* Whether a job is in a loop

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| ACTivity | [jobname][,type][,status] |
+------------------+--------------------------------------------------+

Parameters

If no parameters are specified and there is not a value defined for


PREFIX or OWNER, all jobs are displayed.

+------------------+------------------+-------------------------------+
| Use one jobname | Use one type | Use one status |
| (Optional) | (Optional) | (Optional) |
+------------------+------------------+-------------------------------+
| = | All | All |
| jobname | ATx | In |
| | SYs | Out |
| | STc | |
| | Tsu | |
| | Job | |
| | Ini | |
| | Otx | |
| | NOA | |
| | NOI | |
| | NOJ | |
| | NOO | |
| | NOS | |
| | NOT | |
+------------------+------------------+-------------------------------+

Jobname Parameter Values Explained

+---------------+-----------------------------------------------------+
| Jobname Value | Explanation |
+---------------+-----------------------------------------------------+
| jobname | The full or partial jobname used to limit the |
| | display. |
| | Masking characters can be used when entering a |
| | partial jobname. |
+---------------+-----------------------------------------------------+

Type Parameter Values Explained

+---------------+-----------------------------------------------------+
| Type Value | Explanation |
+---------------+-----------------------------------------------------+
| All | Displays all job types. All is the default. |
+---------------+-----------------------------------------------------+
| ATx | Selects just APPC (Advanced Program-to-Program |
| | Communication) transactions. |
+---------------+-----------------------------------------------------+
| SYs | Displays all system tasks. |
+---------------+-----------------------------------------------------+
| STc | Displays started tasks. |
+---------------+-----------------------------------------------------+
| Tsu | Displays TSO users. |
+---------------+-----------------------------------------------------+
| Job | Displays batch jobs. |
+---------------+-----------------------------------------------------+
| Ini | Displays inactive initiators. |
+---------------+-----------------------------------------------------+
| Otx | Displays OpenMVS transactions. |
+---------------+-----------------------------------------------------+
| NOA | Displays types except APPC transactions, system |
| | tasksm and initiators. |
+---------------+-----------------------------------------------------+
| NOI | Displays types except initiators and system tasks. |
+---------------+-----------------------------------------------------+
| NOJ | Displays types except batch jobs, system tasks, and |
| | initiators. |
+---------------+-----------------------------------------------------+
| NOO | Displays types except OpenMVS transactions, system |
| | tasks and initiators. |
+---------------+-----------------------------------------------------+
| NOS | Displays types except started tasks, system tasks |
| | and initiators. |
+---------------+-----------------------------------------------------+
| NOT | Displays types except TSO users, system tasks, and |
| | initiators. |
+---------------+-----------------------------------------------------+

Status Parameter Values Explained

+---------------+-----------------------------------------------------+
| Status Value | Explanation |
+---------------+-----------------------------------------------------+
| All | Displays jobs of any status. All is the default. |
+---------------+-----------------------------------------------------+
| In | Displays only jobs that are in memory, |
| | including NS, IN, LSW, GO IN, and GO OUT. |
+---------------+-----------------------------------------------------+
| Out | Displays only jobs swapped out. |
+---------------+-----------------------------------------------------+
Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Specifies the name of the job. STARTING is |
| | displayed in the Jobname field if a jobname |
| | has not been established. |
+------------------+--------------------------------------------------+
| Stepname | Specifies the current stepname. |
| | Stepnames are displayed only for jobs that have |
| | have a stepname coded in the JCL. |
+------------------+--------------------------------------------------+
| Procstep | Specifies the current procedure stepname. |
| | Procedure stepnames are displayed only for jobs |
| | that use a PROC statement in the JCL. |
| | For TSO jobs, the terminal name is displayed |
| | in the Procstep field. |
+------------------+--------------------------------------------------+
| Type | Specifies the type of job. |
| | |
| | Possible values are: |
| | |
| | JOB A batch job |
| | SYS A system task |
| | STC A started task |
| | TSU A TSO user |
| | INI An initiator |
| | ATX An APPC transaction |
| | OTX An OpenMVS transaction |
| | |
+------------------+--------------------------------------------------+
| Jobnr | Specifies the job number. |
| | Some system tasks do not have job numbers. |
+------------------+--------------------------------------------------+
| JobClass | Specifies the job input class. |
+------------------+--------------------------------------------------+
| Status | Specifies the status of the job. |
| | |
| | Possible values are: |
| | |
| | NS Nonswappable |
| | LSW Logically swapped |
| | GO OUT Currently being swapped out |
| | GO IN Currently being swapped in |
| | IN Swapped in |
| | OUT TO Swapped out--terminal output wait |
| | OUT TI Swapped out--terminal input wait |
| | OUT LW Swapped out--long wait |
| | OUT XS Swapped out--auxiliary storage |
| | shortage |
| | OUT RS Swapped out--real storage shortage |
| | OUT DW Swapped out--detected wait |
| | OUT RQ Swapped out--requested swap |
| | OUT NQ Swapped out--enqueue exchange swap |
| | OUT EX Swapped out--exchange on recommended |
| | value |
| | OUT US Swapped out--unilateral swap |
| | OUT TS Swapped out--transition swap |
| | OUT IC Swapped out--improve central storage |
| | OUT IP Swapped out--improve system paging |
| | OUT MR Swapped out--make room |
| | OUT AW Swapped out--APPC wait |
| | OUT OI Swapped out--input wait |
| | OUT OO Swapped out--output wait |
| | OUT LS Swapped out--logical swap |
| | OUT LF Swapped out--logical swap fail |
| | OUT SR Swapped out--real swap |
| | blank No address space found with the |
| | specified jobname |
| | |
+------------------+--------------------------------------------------+
| Dispatch | The dispatchability of the address space. |
| | |
| | Possible values are: |
| | |
| | RUNNING The address space has one or more |
| | units of work (tasks or SRBs) |
| | running on a processor. |
| | |
| | READYnnn The address space has one or more |
| | units of work (tasks or SRBs) |
| | that are dispatchable but are |
| | waiting to run on a processor. |
| | The "nnn" portion is the dispatch |
| | priority order up to a maximum of |
| | 255. |
| | |
| | NOTDISP The address space is not |
| | dispatchable. |
| | |
+------------------+--------------------------------------------------+
| CPU-Time | Specifies the accumulated CPU time |
| | (in CPU seconds) used by the job. |
| | |
| | This includes the accounted task time, job |
| | step time, SRB time, and preemptable-class |
| | SRB time. |
+------------------+--------------------------------------------------+
| Limit | Specifies the total amount of CPU time |
| | (in CPU seconds) that the job can use before |
| | timing out. |
| | |
| | Some jobs will not have a value in this field. |
| | |
| | To change this field, overtype the value with a |
| | new value. The value can be a number from |
| | 1 to 21474779. |
| | |
| | Some system jobs and jobs from other systems |
| | cannot be changed. |
| | |
| | This field can come from the TIME parameter on |
| | the JOB card or from other system defaults. |
+------------------+--------------------------------------------------+
| Clocktime | Specifies the amount of wall clock time the job |
| | has been executing. |
+------------------+--------------------------------------------------+
| SRB-Time | Specifies the accumulated SRB time |
| | (in CPU seconds) used by the job. |
+------------------+--------------------------------------------------+
| IOCount | Specifies the number of I/O operations performed |
| | by the job. |
| | |
| | The I/O count is reset when the job |
| | changes steps. |
+------------------+--------------------------------------------------+
| R-Stg | Specifies the amount of real storage the job is |
| | using in the private region. |
+------------------+--------------------------------------------------+
| F-Stg | Specifies the amount of fixed storage the |
| | job is using. |
+------------------+--------------------------------------------------+
| Dp | Specifies the hexadecimal dispatching priority |
| | of the job. |
| | |
| | To change this field, overtype the value in |
| | this field with a new value. |
| | The value must be a hexadecimal value in the |
| | range 0-FF. |
| | |
| | If the value is modified, the following |
| | command will be invoked to process the request: |
| | |
| | ASSET asid DPRTY dp JOBNAME jobname |
| | |
+------------------+--------------------------------------------------+
| ASID | Specifies the hexadecimal address space ID. |
+------------------+--------------------------------------------------+
| CPU% | Specifies the approximate percentage of CPU time |
| | used by the job. |
+------------------+--------------------------------------------------+
| Paging | Specifies the approximate rate, in pages per |
| | second, of page-ins and page-outs for the job. |
+------------------+--------------------------------------------------+
| IO/Sec | Specifies the approximate rate, in I/Os per |
| | second, of operations for the job. |
+------------------+--------------------------------------------------+
| A-Stg | Specifies the amount of auxiliary storage |
| | (paging space) used by the job. |
| | |
| | The number of slots can be calculated by |
| | dividing the number by 4096. |
+------------------+--------------------------------------------------+
| Swapto | Specifies the place where the job is swapped if |
| | the job is swapped out. |
| | |
| | Possible values are: |
| | |
| | DASD |
| | ESTOR (expanded storage) |
| | . |
+------------------+--------------------------------------------------+
| Swapcnt | Specifies the transaction swap count for the job.|
+------------------+--------------------------------------------------+
| Notify | The NOTIFY field from the job card of the job. |
+------------------+--------------------------------------------------+
| Programmer | The programmer name from the job card of the job.|
+------------------+--------------------------------------------------+
| Userid | Specifies the security user ID for the job. |
+------------------+--------------------------------------------------+
| Lasttrans | Specifies the elapsed time since the last |
| | transaction started. Valid formats are: |
| | |
| | Valid formats are: |
| | |
| | nn.nnn (seconds) |
| | hh:mm:ss (up to 99:59:59) |
| | nDAYS |
| | n.nDAYS |
| | n.nnDAYS |
| | nnDAYS |
| | nn.nDAYS |
| | |
+------------------+--------------------------------------------------+
| Attributes | Specifies the attributes for the address space. |
| | |
| | Valid formats are: |
| | |
| | PROT Protected |
| | TI Transaction initiator |
| | TP Transaction program |
| | WLM WLM-managed initiator |
| | |
+------------------+--------------------------------------------------+
| Workid | Specifies the work ID, if the job is a |
| | transaction program. |
+------------------+--------------------------------------------------+
| ASCB | Specifies the ASCB address for the job. |
+------------------+--------------------------------------------------+
| Steptime | Specifies the CPU time (in CPU seconds) |
| | by the current step. |
+------------------+--------------------------------------------------+
| ASIDD | Specifies the decimal address space ID. |
+------------------+--------------------------------------------------+
| Workload | Specifies the workload name when the system is |
| | running in goal mode. |
+------------------+--------------------------------------------------+
| Srvclass | Specifies the service class name. |
| | |
| | To change this field, overtype the field with |
| | a new service class name. |
| | |
| | If the value is modified, the following |
| | command will be invoked to process the request: |
| | |
| | ASSET asid SRVCLASS srvclass JOBNAME jobname |
| | |
+------------------+--------------------------------------------------+
| Srvp | Specifies the service period when the system is |
| | running in goal mode. |
+------------------+--------------------------------------------------+
| Resgroup | Specifies the resource group name when the |
| | system is running in goal mode. |
+------------------+--------------------------------------------------+
| TRG | Specifies whether the name displayed in the |
| | "Resgroup" field is a Tenant Resource Group. |
| | |
| | Possible values are: |
| | |
| | TRG - The name is a Tenant Resource |
| | Group. |
| | blank - The name is not a Tenant Resource |
| | Group. |
| | |
+------------------+--------------------------------------------------+
| Server | Specifies the server indicator when the system |
| | is running in goal mode. |
+------------------+--------------------------------------------------+
| Quiesce | Specifies the quiesce indicator when the system |
| | is running in goal mode. |
| | |
| | To change this field, overtype the field |
| | with YES to quiesce the address space or NO to |
| | resume activity. |
| | |
| | If the value is modified, the following command |
| | is invoked to process the request: |
| | |
| | ASQUIESC asid JOBNAME jobname |
| | ASRESUME asid JOBNAME jobname |
| | |
+------------------+--------------------------------------------------+
| CSA | Specifies the amount of CSA storage used by the |
| | job. |
| | |
| | This is valid only if the Virtual Storage |
| | Manager (VSM) tracking facility is active. |
+------------------+--------------------------------------------------+
| E-CSA | Specifies the amount of extended CSA storage |
| | used by the job. |
| | |
| | This is valid only if the Virtual Storage |
| | Manager (VSM) tracking facility is active. |
+------------------+--------------------------------------------------+
| RUCSA | Specifies the amount of RUCSA storage used by |
| | the job. |
| | |
| | This is valid only if the Virtual Storage |
| | Manager (VSM) tracking facility is active. |
+------------------+--------------------------------------------------+
| E-RUCSA | Specifies the amount of extended RUCSA storage |
| | used by the job. |
| | |
| | This is valid only if the Virtual Storage |
| | Manager (VSM) tracking facility is active. |
+------------------+--------------------------------------------------+
| SQA | Specifies the amount of SQA storage used by |
| | the job. |
| | |
| | This is valid only if the Virtual Storage |
| | Manager (VSM) tracking facility is active. |
+------------------+--------------------------------------------------+
| E-SQA | Specifies the amount of extended SQA storage |
| | used by the job. |
| | |
| | This is valid only if the Virtual Storage |
| | Manager (VSM) tracking facility is active. |
+------------------+--------------------------------------------------+
| C-Stg | Specifies the total amount of common storage |
| | used by the job. |
| | |
| | This is valid only if the Virtual Storage |
| | Manager (VSM) tracking facility is active. |
+------------------+--------------------------------------------------+
| Omvs | Specifies OMVS if the address space is an |
| | OpenMVS process; otherwise it is blank. |
+------------------+--------------------------------------------------+
| PJobname | OpenMVS process parent jobname. |
+------------------+--------------------------------------------------+
| PASID | OpenMVS process parent ASID. |
+------------------+--------------------------------------------------+
| IODelta | Specifies the number of I/Os during the |
| | sampling interval. |
+------------------+--------------------------------------------------+
| CPUDelta | Specifies the CPU time consumed during the |
| | sampling interval. |
+------------------+--------------------------------------------------+
| E-Cnt | Specifies the enclave TCB summary count. |
+------------------+--------------------------------------------------+
| EnclTime | Specifies the cumulative CPU time for all |
| | completed independent, dependent, and |
| | MONENV enclaves owned by the address space. |
+------------------+--------------------------------------------------+
| AddSRBtm | Specifies additional SRB service time. |
| | |
| | This field contains cumulative CPU time for the |
| | preemptable SRBs and client-related SRBs for |
| | which this address space is the client. |
+------------------+--------------------------------------------------+
| PreSRBtm | Specifies the preemptable-class SRB service time.|
| | |
| | This field contains cumulative CPU time for |
| | all types of preemptable SRBs executing with |
| | this address space as the home address space. |
+------------------+--------------------------------------------------+
| CPUProt | Specifies whether CPU protection has been |
| | assigned to the address space. |
+------------------+--------------------------------------------------+
| StgProt | Specifies whether storage protection has been |
| | assigned to the address space. |
+------------------+--------------------------------------------------+
| MemLm | Specifies the memory limit on the total number |
| | of usable virtual pages above the bar. |
+------------------+--------------------------------------------------+
| SCPU% | Specifies the CPU percent for the system |
| | where the job is running. |
| | |
| | This field is displayed only when displaying |
| | cross-system data. |
+------------------+--------------------------------------------------+
| RptClass | Specifies the reporting class when the system |
| | is running in goal mode. |
+------------------+--------------------------------------------------+
| RdyTsk | Specifies the number of tasks on the ready to |
| | execute queue. |
+------------------+--------------------------------------------------+
| CPTime | Specifies the accumulated general processor time.|
+------------------+--------------------------------------------------+
| IFATime | Specifies the accumulated IFA processor time. |
+------------------+--------------------------------------------------+
| IFAElig | Specifies the accumulated general processor |
| | time that was eligible for an IFA processor. |
+------------------+--------------------------------------------------+
| IIPtime | The cumulative IIP CPU time used. |
+------------------+--------------------------------------------------+
| IIPonCP | The cumulative IIP eligible time on CP. |
+------------------+--------------------------------------------------+
| IIPencl | The cumulative enclave IIP CPU time used. |
+------------------+--------------------------------------------------+
| CPUT% | CPU% * the number of CPUs. |
+------------------+--------------------------------------------------+
| ASIType | Address Space Identification type. |
| | |
| | SYSVIEW will assign address space |
| | identification types, subtypes and attributes |
| | to jobs at job start or the start of each step |
| | within a job. |
| | |
| | SYSVIEW uses a pre-defined set of rules to |
| | determine the type, subtype and attributes |
| | for a job. If unable to assign a specific type, |
| | the address space identification type or |
| | "AsiType" will be set to the program module |
| | specified on the "EXEC PGM=program" JCL |
| | statement. |
| | |
| | The following is a sample list of address |
| | space identification types: |
| | |
| | CICS A CICS region. |
| | |
| | DB2 An IBM Db2 address space. |
| | |
| | DCD A Data Content Discovery |
| | address space. |
| | |
| | IMS An IMS region: BMP, MPP, or JMP. |
| | |
| | JAVA The Java launcher program was |
| | invoked from the Java zFS |
| | directory using a USS batch |
| | utility, exec() or fork() service. |
| | |
| | JZOS The IBM Java Batch Launcher and |
| | Toolkit for z/OS. |
| | |
| | WAS A WebSphere Application Server |
| | address space. |
| | |
| | WAS_LIBERTY A WebSphere Application Server |
| | address space. |
| | |
| | ZCX An IBM z/OS Container Extensions |
| | address space. |
| | |
| | ZOSCONNECT An IBM z/OS Connect EE |
| | address space. |
| | |
| | other The module name from the PGM= |
| | parameter of the JCL EXEC |
| | statement. |
| | |
| | blank The address space started before |
| | SYSVIEW was fully initialized. |
| | If the address space performs any |
| | module load activity, SYSVIEW |
| | will identify the value for the |
| | field. |
| | |
| | A list of address space identification types can |
| | be viewed using the ASITYPES command. |
| | |
| | Additional Address Space Identification |
| | information. |
+------------------+--------------------------------------------------+
| ASISubType | Address Space Identification subtype. |
| | |
| | This field provides additional details for |
| | identifying an address space type. The content |
| | of this field is dependent on the type value |
| | displayed in the ASIType field. |
| | |
| | This field will be blank if there is no |
| | additional identifying information. |
+------------------+--------------------------------------------------+
| Program | The module name from the PGM= parameter of |
| | the EXEC statement. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Notes

Highlighted Lines

The Jobname field for a job is highlighted as long as the


job remains in memory. The Jobname field is not highlighted
when the job is swapped out.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| A | Invokes the ASID command for the selected ASID. |
+---------------+------------------------------------------------------------+
| C | Cancels the job. If delete confirmation is in effect, |
| | enter YES when the confirmation message appears. |
+---------------+------------------------------------------------------------+
| CD | Cancels the job with a dump. If delete confirmation is in |
| | effect, enter YES when the confirmation message appears. |
+---------------+------------------------------------------------------------+
| E | Restarts the job. |
+---------------+------------------------------------------------------------+
| FO | Forces the termination of the job. Use this line command |
| | only if the C line command will not cancel the job. An |
| | IPL might be required after using the FO line command. |
| | After entering the FO line command, enter YES to confirm |
| | the termination of the job. |
+---------------+------------------------------------------------------------+
| H | Holds the job. |
+---------------+------------------------------------------------------------+
| KIL | Forces the termination of the job. Use this line command |
| | only if the C and FO line commands do not work. An IPL |
| | might be required after using the KIL line command. After |
| | entering the KIL line command, enter YES to confirm the |
| | termination of the job. |
+---------------+------------------------------------------------------------+
| MAT | Schedule an event with Mainframe Application Tuner |
| | to monitor the selected address space. |
| | Invokes the CLIST CAMAT. |
+---------------+------------------------------------------------------------+
| NS | Makes a job nonswappable. |
+---------------+------------------------------------------------------------+
| STOp | Issues a STOP request for the jobname and ASID if the type |
| P | is STC. |
+---------------+------------------------------------------------------------+
| R | Releases the job. |
+---------------+------------------------------------------------------------+
| SW | Makes a job swappable. Making a job swappable that is |
| | designed to run nonswappable can cause the job to fail. |
+---------------+------------------------------------------------------------+

Navigation Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| DSalloc | Invokes the DSALLOC command to list allocated datasets. |
+---------------+------------------------------------------------------------+
| ENQueue | Invokes the ENQJOB command to list the enqueues for the |
| NQ | job. |
+---------------+------------------------------------------------------------+
| J | Invokes ISPF EDIT to display the JCL for the job. |
| | Changes are not saved. |
+---------------+------------------------------------------------------------+
| L | Invokes the LISTFILE command to list the output files for |
| | the job. |
+---------------+------------------------------------------------------------+
| LL | Invokes the LISTLOAD command to list loaded modules. |
+---------------+------------------------------------------------------------+
| M | Invokes the MENU ADDRSPC command. |
+---------------+------------------------------------------------------------+
| OD | Invokes the JOUTDES command to display the output |
| JOD | descriptors. |
+---------------+------------------------------------------------------------+
| PCpu | Plot CPU usage. |
+---------------+------------------------------------------------------------+
| PIorate | Plot I/O rate. |
+---------------+------------------------------------------------------------+
| PLot | Invokes a PLOTLIST ASID command to display a plot |
| | selection list for the selected job. |
+---------------+------------------------------------------------------------+
| PPaging | Plot paging rate. |
+---------------+------------------------------------------------------------+
| PR | Invokes the PRIVATE command to list private storage usage. |
+---------------+------------------------------------------------------------+
| PStorage | Plot real storage. |
+---------------+------------------------------------------------------------+
| ROW | Invokes the ROWDISP command for the selected job. |
+---------------+------------------------------------------------------------+
| S | Invokes the OUTPUT command to display the output. |
+---------------+------------------------------------------------------------+
| SS | Invokes the STEPSUM command to display a summary of the |
| | steps for the job. |
+---------------+------------------------------------------------------------+
| T | Invokes the TASK command to list tasks for the job. |
+---------------+------------------------------------------------------------+
| TM | Invokes the TASKMON command for the job. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. |
+---------------+------------------------------------------------------------+

Messages

ACTI001I No data to display

No jobs match the parameters entered with the ACTIVITY command.


Enter another ACTIVITY command or the REFRESH subcommand to update
the display.

ACTI002I List is incomplete

Not enough storage is available to handle all of the jobs to be


displayed. The display does not show all of the jobs that match
the parameters entered with the ACTIVITY command. If possible,
specify parameters that reduce the number of jobs to display.

ACTI003E Line command [command] is not valid for job [jobname]

The line command [command] is specified in the command field for


the job [jobname], but the line command is invalid. Clear the
line command, or enter another line command.

ACTI004E Cannot force job [jobname]

Job [jobname] cannot be forced from the system because it is


marked as a non-forcible address space.

ACTI005W Force rejected for job [jobname]. Try cancel first

Before using the FO line command for job [jobname], use the
C line command to cancel the job first.

ACTI006E Call to RMF interface failed, RC=[rtncd], reason=[rsncd]

The call to an RMF module to get information failed. Note


the return and reason codes.
Contact technical support.
ACTJOB

ACTJOB Command

The ACTJOB command displays a summary of activity for the job or


address space that has been collected by the MVS data collector.

The collection of address space related metrics can be enabled and


disabled by the specific metric or variable name. All possible
metrics may not be displayed.

The data for this command requires the following to be active:

* MVS Data Collector - Task name MVSDATA


* Scheduled Event function - MVSDATA-JOBS

Command Syntax

+------------------+--------------------------------------------------+
| ACTJob | [asid] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| asid | The ASID of the target address space. |
| | |
| | For details on the ASID parameter, see the ASID |
| | command. If the ASID parameter is omitted, |
| | then the current ASID is used. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. This is a concatenation of |
| | the current job type and job number. |
| | Example: TSU03654 |
+------------------+--------------------------------------------------+
| Interval | The elapsed time interval for the "Current" |
| | value. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Metric | The data collection metric name. |
+------------------+--------------------------------------------------+
| Current | The current real-time resource value. |
| | |
| | The collection interval for this value is |
| | displayed in the information section. |
+------------------+--------------------------------------------------+
| ShortAvg | The short average value is defined as the |
| | average resource value over the last two data |
| | collection intervals. |
+------------------+--------------------------------------------------+
| HourAvg | The hourly average value is the average resource |
| | value over the last 60 minutes. |
+------------------+--------------------------------------------------+
| HourMin | The minimum average value for the last hour. |
+------------------+--------------------------------------------------+
| HourMax | The maximum average value for the last hour. |
+------------------+--------------------------------------------------+
| Status | The current status based on defined thresholds. |
| | Possible values are: |
| | |
| | blank Threshold not defined |
| | NORMAL |
| | WARNING |
| | PROBLEM |
+------------------+--------------------------------------------------+
| MetAlias | The metric alias. |
+------------------+--------------------------------------------------+
| Description | A description of the metric resource. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Graph | Invokes the GRAPH command for the selected |
| | entry. |
+------------------+--------------------------------------------------+
| Plot | Invokes the PLOT command for the selected |
| | entry. |
+------------------+--------------------------------------------------+
| Select | Invokes the MOREINFO command for the selected |
| | entry. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
ACTSUM

ACTSUM Command

The ACTSUM command displays address space time information


that has been collected by the MVS Data Collector. Status
is indicated based on exception checking performed during
the last threshold interval. Alert status is only displayed
if the CURRENT interval is requested.

The data for this command requires the following to be active:

* MVS Data Collector - Task name MVSDATA


* Scheduled Event function - MVSDATA-JOBS

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+---------------------------------------------------------------------+
| | |
| ACTSUM | [ mode ] |
| | |
| | [ Normal | Warning | Problem ] |
| | |
| | [ NOXSData | XSData ] |
| | [ NOXSYStem | XSYStem ] |
| | |
| | [ DESC | NODESC ] |
| | [ JOBREQ | NOJOBREQ ] |
| | |
| | [ JOBName jobname ] |
| | [ JOBId jobid ] |
| | [ TYPE jobtype ] |
| | [ INTerval minutes ] |
| | |
| | [ COLumns column1 ... columnn ] |
| | |
+---------------------------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| Mode | The display mode. The mode specifies what |
| | values are to be displayed. |
| | |
| | Current |
| | |
| | The values displayed are current values. |
| | The current value is calculated by averaging |
| | the last "nn" intervals. The number of |
| | intervals to be averaged is specified using |
| | the "INTERVAL minutes" parameter. |
| | |
| | Last |
| | |
| | The last interval value collected. |
| | |
| | Average |
| | |
| | The average value over the last hour. |
| | |
| | MInimum |
| | |
| | The minimum value over the last hour. |
| | |
| | MAximum |
| | |
| | The maximum value over the last hour. |
| | |
+------------------+--------------------------------------------------+
| Normal | Specifies all entries. |
+------------------+--------------------------------------------------+
| Warning | Specifies only those entries that have a |
| | combined status of warning or higher. |
+------------------+--------------------------------------------------+
| Problem | Specifies only those entries that have a |
| | combined status of problem. |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross system data collection to be |
| XSData | set on for this execution of the command. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution of the command. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| DESC | Display jobname description if available. |
+------------------+--------------------------------------------------+
| NODESC | Do not display jobname description. |
+------------------+--------------------------------------------------+
| JOBREQ | Display jobname required to be active status. |
+------------------+--------------------------------------------------+
| NOJOBREQ | Do not display jobname required to be active |
| | status. |
+------------------+--------------------------------------------------+
| JOBName | Limit the display to only those entries with a |
| | corresponding value in the Jobname field. |
+------------------+--------------------------------------------------+
| JOBId | Limit the display to only those entries with a |
| | corresponding value in the Jobid field. |
+------------------+--------------------------------------------------+
| TYPE | Limit the display to only those entries with a |
| | corresponding value in the Type field. |
+------------------+--------------------------------------------------+
| INTerval | Specifies the interval to be used when |
| | calculating the "Current" value. |
| | Valid values are: |
| | |
| | Default: 2 |
| | Minimum: 1 |
| | Maximum: 60 |
+------------------+--------------------------------------------------+
| COLumns | Specify a list of column header field names |
| | to be displayed. |
| | |
| | Specifying a list can reduce overhead when |
| | only a small number of columns are needed. |
| | |
| | Example: |
| | ACTSUM COLUMNS CPUT% CPUTIME REALSTG |
| | |
| | The following columns cannot be specified and |
| | will always display data: |
| | |
| | Jobname |
| | ASID |
| | Type |
| | JobId |
| | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Mode | The requested display mode. |
| | Possible values are: |
| | |
| | CURRENT |
| | AVERAGE |
| | MINIMUM |
| | MAXIMUM |
+------------------+--------------------------------------------------+
| Interval | The number of data collection intervals that |
| | are averaged to compute the current value. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the address space |
+------------------+--------------------------------------------------+
| ASID | The address space ID |
+------------------+--------------------------------------------------+
| Type | The type of job. |
| | Possible values are: |
| | |
| | JOB A batch job |
| | SYS A system task |
| | STC A started task |
| | TSU A TSO user |
| | INI An initiator |
| | ATX An APPC transaction |
| | OTX An OpenMVS transaction |
+------------------+--------------------------------------------------+
| JobId | The job ID of the address space |
+------------------+--------------------------------------------------+
| CPUT% | CPU usage percentage total |
+------------------+--------------------------------------------------+
| CPUTime | CPU time |
+------------------+--------------------------------------------------+
| IORate | I/Os per seconds |
+------------------+--------------------------------------------------+
| IOCount | I/O count |
+------------------+--------------------------------------------------+
| PageRate | Paging rate |
+------------------+--------------------------------------------------+
| RealStg | Real storage |
+------------------+--------------------------------------------------+
| AuxStg | Auxiliary storage |
+------------------+--------------------------------------------------+
| WorkSet | Working set size |
| | Real storage + Auxiliary storage |
+------------------+--------------------------------------------------+
| SCMStg | Storage Class Memory (SCM) |
+------------------+--------------------------------------------------+
| GRealStg | Real storage to back 64-bit private |
+------------------+--------------------------------------------------+
| GAuxStg | Auxiliary storage to back 64-bit private |
+------------------+--------------------------------------------------+
| ClockTim | Wall clock time |
+------------------+--------------------------------------------------+
| CSA | CSA storage allocated |
+------------------+--------------------------------------------------+
| E-CSA | E-CSA storage allocated |
+------------------+--------------------------------------------------+
| RUCSA | RUCSA storage allocated |
+------------------+--------------------------------------------------+
| E-RUCSA | E-RUCSA storage allocated |
+------------------+--------------------------------------------------+
| SQA | SQA storage allocated |
+------------------+--------------------------------------------------+
| E-SQA | E-SQA storage allocated |
+------------------+--------------------------------------------------+
| G-CSA | G-CSA storage allocated |
+------------------+--------------------------------------------------+
| CPU% | CPU usage percentage |
| | This value can vary due to the number on online |
| | and parked processors. |
+------------------+--------------------------------------------------+
| CP% | CP usage percentage |
| | This value can vary due to the number on online |
| | and parked processors. |
+------------------+--------------------------------------------------+
| CPT% | CP usage percentage total |
+------------------+--------------------------------------------------+
| CPTime | CP time |
+------------------+--------------------------------------------------+
| SRBTime | SRB time |
+------------------+--------------------------------------------------+
| TCBTime | TCB time |
+------------------+--------------------------------------------------+
| MIPS | Million Instructions Per Second (MIPS) |
+------------------+--------------------------------------------------+
| ASRBTime | Additional SRB Service Time |
+------------------+--------------------------------------------------+
| PSRBTime | Preemptable-class SRB Time |
+------------------+--------------------------------------------------+
| IIP% | IIP usage percentage |
| | This value can vary due to the number on online |
| | and parked processors. |
+------------------+--------------------------------------------------+
| IIPT% | IIP usage percentage total |
+------------------+--------------------------------------------------+
| IIPTime | IIP CPU time |
| | Normalized to a CP processor |
+------------------+--------------------------------------------------+
| IIPonCP | IIP eligible time on CP |
+------------------+--------------------------------------------------+
| IIPEnCP | IIP Enclave CPU time on CP |
+------------------+--------------------------------------------------+
| IIPEncl | IIP Enclave CPU time |
+------------------+--------------------------------------------------+
| IIPEnclT | IIP Enclave CPU time total |
+------------------+--------------------------------------------------+
| IIPEncl% | IIP Enclave pct of total CPU time |
+------------------+--------------------------------------------------+
| EnclTime | Enclave time (interval) |
+------------------+--------------------------------------------------+
| Enclave% | Enclave pct of interval CPU time |
+------------------+--------------------------------------------------+
| EnclTot | Enclave time (total) |
+------------------+--------------------------------------------------+
| EnclTot% | Enclave pct of total CPU time |
+------------------+--------------------------------------------------+
| IFA% | IFA usage percentage |
| | This value can vary due to the number on online |
| | and parked processors. |
+------------------+--------------------------------------------------+
| IFAT% | IFA usage percentage total |
+------------------+--------------------------------------------------+
| IFATime | IFA CPU time |
| | Normalized to a CP processor |
+------------------+--------------------------------------------------+
| IFAonCP | IFA eligible time on CP |
+------------------+--------------------------------------------------+
| ALL% | All processors usage percentage |
+------------------+--------------------------------------------------+
| ALLT% | All processors usage percentage total |
+------------------+--------------------------------------------------+
| Pvt% | Private storage user pct used |
+------------------+--------------------------------------------------+
| PvtUnAl | Private storage unallocated |
+------------------+--------------------------------------------------+
| PvtUser | Private storage user allocated |
+------------------+--------------------------------------------------+
| EPvt% | E-Private storage user pct used |
+------------------+--------------------------------------------------+
| EPvtUnAl | E-Private storage unallocated |
+------------------+--------------------------------------------------+
| EPvtUser | E-Private storage user allocated |
+------------------+--------------------------------------------------+
| GPvtAllo | G-Private storage allocated |
+------------------+--------------------------------------------------+
| SlotCnt | Slots count |
+------------------+--------------------------------------------------+
| Slot% | Slot percent in use |
+------------------+--------------------------------------------------+
| Fixed | Total fixed storage |
+------------------+--------------------------------------------------+
| FixBelow | Fixed storage above 16M line |
+------------------+--------------------------------------------------+
| FixAbove | Fixed storage above 16M line |
+------------------+--------------------------------------------------+
| FixLSQA | Fixed LSQA storage |
+------------------+--------------------------------------------------+
| PageCnt | Paging count |
+------------------+--------------------------------------------------+
| PageIn | Non-VAM page in count |
+------------------+--------------------------------------------------+
| PageOut | Non-VAM page out count |
+------------------+--------------------------------------------------+
| ComPagIn | Common page in count |
+------------------+--------------------------------------------------+
| HpPagI | Hyperspace page in count |
+------------------+--------------------------------------------------+
| HpPagO | Hyperspace page out count |
+------------------+--------------------------------------------------+
| LPAPagI | LPA page in count |
+------------------+--------------------------------------------------+
| PagStole | Pages stolen from memory |
+------------------+--------------------------------------------------+
| CachMiss | Cache read page miss count |
+------------------+--------------------------------------------------+
| SwapCnt | Swap count |
+------------------+--------------------------------------------------+
| SwapIn | Swap page in count |
+------------------+--------------------------------------------------+
| SwapOut | Swap page out count |
+------------------+--------------------------------------------------+
| VAMPagI | VAM page in count |
+------------------+--------------------------------------------------+
| VAMPagO | VAM page out count |
+------------------+--------------------------------------------------+
| VAMPagR | VAM page reclaims |
+------------------+--------------------------------------------------+
| IOSamp | I/O sample count |
+------------------+--------------------------------------------------+
| IOConn | I/O connect time |
+------------------+--------------------------------------------------+
| IODisc | I/O disconnect time |
+------------------+--------------------------------------------------+
| IOWait | I/O wait time |
+------------------+--------------------------------------------------+
| IOConnT | Total I/O connect time |
+------------------+--------------------------------------------------+
| IODiscT | Total I/O disconnect time |
+------------------+--------------------------------------------------+
| IOWaitT | Total I/O wait time |
+------------------+--------------------------------------------------+
| EXCPO | EXCPs outstanding |
+------------------+--------------------------------------------------+
| CPUSU | CPU service units |
+------------------+--------------------------------------------------+
| IOSU | I/O service units |
+------------------+--------------------------------------------------+
| MSOSU | MSO service units |
+------------------+--------------------------------------------------+
| SRBSU | SRB service units |
+------------------+--------------------------------------------------+
| WMSSU | Service units |
+------------------+--------------------------------------------------+
| CPUSR | CPU service units per second |
+------------------+--------------------------------------------------+
| IOSR | I/O service units per second |
+------------------+--------------------------------------------------+
| MSOSR | MSO service units per second |
+------------------+--------------------------------------------------+
| SRBSR | SRB service units per second |
+------------------+--------------------------------------------------+
| WMSSR | Service units per second |
+------------------+--------------------------------------------------+
| USSCalls | USS Syscalls |
+------------------+--------------------------------------------------+
| USSChrR | USS Character special read I/O blocks |
+------------------+--------------------------------------------------+
| USSChrW | USS Character special write I/O blocks |
+------------------+--------------------------------------------------+
| USSDirR | USS Directory read I/O blocks |
+------------------+--------------------------------------------------+
| USSFilR | USS Standard file read I/O blocks |
+------------------+--------------------------------------------------+
| USSFilW | USS File write I/O blocks |
+------------------+--------------------------------------------------+
| USSMsgR | USS Message receive bytes |
+------------------+--------------------------------------------------+
| USSMsgS | USS Message send bytes |
+------------------+--------------------------------------------------+
| USSPGnL | USS Path gen. calls - logical file sys |
+------------------+--------------------------------------------------+
| USSPGnP | USS Path gen. - physical file sys. |
+------------------+--------------------------------------------------+
| USSPipR | USS Pipe read I/O blocks |
+------------------+--------------------------------------------------+
| USSPipW | USS Pipe write I/O blocks |
+------------------+--------------------------------------------------+
| USSPlkL | USS Path lookup - logical file sys. |
+------------------+--------------------------------------------------+
| USSPlkP | USS Path lookup - physical file sys. |
+------------------+--------------------------------------------------+
| USSProc | USS Process count |
+------------------+--------------------------------------------------+
| USSSocR | USS Remote socket read I/O blocks |
+------------------+--------------------------------------------------+
| USSSocW | USS Remote socket write I/O blocks |
+------------------+--------------------------------------------------+
| USSSync | USS Calls to SYNC() |
+------------------+--------------------------------------------------+
| JSSAMPLE | Job state samples |
+------------------+--------------------------------------------------+
| JSACT% | Job state active or delayed pct |
+------------------+--------------------------------------------------+
| JSIDLE% | Job state idle pct |
+------------------+--------------------------------------------------+
| JSSWAP% | Job state swapped-out pct |
+------------------+--------------------------------------------------+
| JSSWAR% | Job state swapped-out ready |
+------------------+--------------------------------------------------+
| JSUNK% | Job state unknown pct |
+------------------+--------------------------------------------------+
| JSUSING% | Job using pct |
+------------------+--------------------------------------------------+
| JSUCPU% | Job using CPU pct |
+------------------+--------------------------------------------------+
| JSUDEV% | Job using device pct |
+------------------+--------------------------------------------------+
| JSDELAY% | Job delayed pct |
+------------------+--------------------------------------------------+
| JSDCPU% | Job delayed by CPU pct |
+------------------+--------------------------------------------------+
| JSDDEV% | Job delayed by device pct |
+------------------+--------------------------------------------------+
| JSDENQ% | Job delayed by enqueue pct |
+------------------+--------------------------------------------------+
| JSDHSM% | Job delayed by HSM pct |
+------------------+--------------------------------------------------+
| JSDJES% | Job delayed by JES pct |
+------------------+--------------------------------------------------+
| JSDOMNT% | Job delayed by OPER mount pct |
+------------------+--------------------------------------------------+
| JSDOMSG% | Job delayed by OPER message pct |
+------------------+--------------------------------------------------+
| JSDOPER% | Job delayed by OPER pct |
+------------------+--------------------------------------------------+
| JSDSHRS% | Job delayed for shared storage pct |
+------------------+--------------------------------------------------+
| JSDSTG% | Job delayed by paging or swapping pct |
+------------------+--------------------------------------------------+
| JSDSUBS% | Job delayed by subsystem pct |
+------------------+--------------------------------------------------+
| JSDXCF% | Job delayed by XCF pct |
+------------------+--------------------------------------------------+
| JobReq | Indicates if the job has been defined as a job |
| | that is required to be active. |
| | |
| | Possible values are: |
| | blank - job is not required to be active |
| | JOBREQ - job is required to be active |
| | |
| | Required jobs can be defined via the MONRULES |
| | command. |
| | |
| | Metric Exclude RsceScope |
| | MVS_JOB_Status INCLUDE jobname |
| | |
+------------------+--------------------------------------------------+
| TypeJobname | The job type and job name concatenated as a |
| | string. |
| | |
| | Format: type.jobname |
| | |
+------------------+--------------------------------------------------+
| ASTypeSubJobname | The concatenated values of: |
| | address space identifier type |
| | address space identifier subtype |
| | jobname |
| | |
| | Format: AsiType.AsiSubtype.Jobname |
| | |
+------------------+--------------------------------------------------+
| Description | A description of the address space based on the |
| | jobname. The description for a jobname is |
| | defined in the parmlib member JOBNAMES. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Alerts | Invokes the ALERTS command to display data |
| | collection statistics and exception |
| | information. |
+------------------+--------------------------------------------------+
| JJobque | Invokes the JJOBQUE command for the selected |
| LJ | jobname. |
+------------------+--------------------------------------------------+
| LISTFile | Invokes the LISTFILE command for the selected |
| LF | jobname. |
+------------------+--------------------------------------------------+
| PCpu | Plot CPU usage. |
+------------------+--------------------------------------------------+
| PIorate | Plot I/O rate. |
+------------------+--------------------------------------------------+
| PLot | Invokes a PLOTLIST ASID command to display a |
| | plot selection list for the selected job. |
+------------------+--------------------------------------------------+
| PPaging | Plot paging rate. |
+------------------+--------------------------------------------------+
| PStorage | Plot real storage. |
+------------------+--------------------------------------------------+
| Select | Invoke the ACTIVITY command for the selected |
| | jobname. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
ADREGION

ADREGION Command

The ADREGION command reports the name of the region in which an address
resides in a message.

Command Syntax

+---------------+------------------------------------------------------------+
| ADREGION | [address] |
+---------------+------------------------------------------------------------+

Parameters

Address Parameter Format

Use the following format for the address parameter:

+----------------------------------------------------------------------------+
| [prefix]base[suffix][+|-offset[suffix][+|-offset[suffix]]...] |
+----------------------------------------------------------------------------+

Address Parameter - Prefix

+----------------+-----------------------------------------------------------+
| Prefix | Explanation |
+----------------+-----------------------------------------------------------+
| @ | Specifies that the address should be treated as a 31-bit |
| | indirect address. This address is treated as the address |
| | of an address. |
+----------------+-----------------------------------------------------------+
| % | Specifies that the address should be treated as a 24-bit |
| | indirect address. This address is treated as the address |
| | of an address. |
+----------------+-----------------------------------------------------------+

Address Parameter - Base

+----------------+-----------------------------------------------------------+
| Base | Explanation |
+----------------+-----------------------------------------------------------+
| = | The start location reference. The start location is |
| | defined as the last address dumped, disassembled, or |
| | mapped. This address is displayed in the information |
| | area in the Start field. The DUMP, DISASSEM, and MAP |
| | commands set a new start address and a new current |
| | location. |
+----------------+-----------------------------------------------------------+
| * | The current location reference. The current location is |
| | defined as the address of the first byte of DUMP, |
| | DISASSEM, or MAP data currently displayed. The current |
| | location reference is valid only when DUMP, DISASSEM, or |
| | MAP data is displayed. |
+----------------+-----------------------------------------------------------+
| ¢ | The cursor location reference. The data pointed to by |
| | the cursor is processed as though you had typed it in |
| | place of the ¢ in the command input field. The data |
| | taken from the cursor location on the screen is delimited |
| | by the first nonalphanational character encountered or |
| | the end of the screen row. |
+----------------+-----------------------------------------------------------+
| hexadecimal | 1-16 hexadecimal characters. You may also include one |
| | or more hex separator characters (the underscore) in this |
| | string. How the hex separator characters are handled is |
| | controlled by the setting of the HEXSEPFORMAT option. |
| | To specify an address in the range 00000000_80000000 to |
| | 00000000_FFFFFFFF you must specify at least one leading 0 |
| | (for a total length of 9 or more hex digits). An address |
| | of 8 or less hex digits is assumed to be a 31-bit address |
| | and bit 0 (bit 32 of the corresponding 64-bit address) |
| | will be cleared to 0. |
+----------------+-----------------------------------------------------------+
| decimal | 1-20 decimal digits followed by a decimal point (period). |
+----------------+-----------------------------------------------------------+
| symbol | The address of a predefined symbol or a symbol defined |
| | with the EQUATE command. Defined symbols can be
| | displayed with the SYMBOLS command. |
+----------------+-----------------------------------------------------------+
| symbol.maplabel| The address of a map label defined in a loaded map |
| | associated with the symbol. The SYMBOLS and LISTMAPS |
| | command both display the associations between symbols and |
| | maps. |
+----------------+-----------------------------------------------------------+
| modulename | The address of a module in storage located in the |
| | nucleus, link pack area, job pack area (of the current |
| | ASID), or on the loaded module queue for any TCB in the |
| | current ASID. |
+----------------+-----------------------------------------------------------+

Address Parameter - Suffix

+----------------+-----------------------------------------------------------+
| Suffix | Explanation |
+----------------+-----------------------------------------------------------+
| ? | 31-bit indirect address. You can use multiple ? |
| | characters. |
+----------------+-----------------------------------------------------------+
| % | 24-bit indirect address. You can use multiple % |
| | characters. |
+----------------+-----------------------------------------------------------+
| ! | 64-bit indirect address. You can use multiple ! |
| | characters. |
+----------------+-----------------------------------------------------------+
| \ | 31-bit base+offset indirect address. You can use |
| | multiple \ characters. |
+----------------+-----------------------------------------------------------+

Indirect Address Character Processing

Indirect addresses specified using the indirect address


suffix characters are resolved as they are encountered
processing the address parameter from left to right. An
indirect address specified using an indirect address
prefix character is resolved last after the address
parameter has been completely processed. The base+offset
indirect address character requests that the value at
the indirect address be added to the current base value
(set with the BASE command) and the resulting value be
used as the address.

Address Parameter - Offset

+--------------------+-------------------------------------------------------+
| Offset | Explanation |
+--------------------+-------------------------------------------------------+
| hexadecimal | 1-16 hexadecimal characters. You may also include |
| | one or more hex separator characters (the underscore) |
| | in this string. How the hex separator characters are |
| | handled is controlled by the SET HEXSEPFORMAT option. |
+--------------------+-------------------------------------------------------+
| decimal | 1-20 decimal digits followed by a decimal point. |
+--------------------+-------------------------------------------------------+
| symbol | The address of a predefined symbol or a symbol |
| | defined with the EQUATE command. Defined symbols can |
| | be displayed with the SYMBOLS command. |
+--------------------+-------------------------------------------------------+
| L'symbol | The length of a symbol. |
+--------------------+-------------------------------------------------------+
| symbol.maplabel | The address of a map label defined in a loaded map |
| | associated with the symbol. The SYMBOLS and LISTMAPS |
| | commands both display the associations between |
| | symbols and maps. |
+--------------------+-------------------------------------------------------+
| L'symbol.maplabel | The length of a field named maplabel found in the map |
| | associated with the symbol. |
+--------------------+-------------------------------------------------------+
| L'mapname | The length of a map. |
+--------------------+-------------------------------------------------------+
| L'mapname.maplabel | The length of a field named maplabel found in the map |
| | named mapname. |
+--------------------+-------------------------------------------------------+
| modulename | The address of a module in storage located in |
| | nucleus, the link pack area, or the job pack area of |
| | the current ASID, or on the loaded module queue for |
| | any TCB in the current ASID. |
+--------------------+-------------------------------------------------------+
| L'modulename | The length of a module. |
+--------------------+-------------------------------------------------------+
| nnnnnnnK | The number of kilobytes. The nnnnnnn portion must be |
| | a decimal number that is multiplied by 1024. |
+--------------------+-------------------------------------------------------+
| nnnnnnnP | The number of pages. The nnnnnnn portion must be a |
| | decimal number that is multiplied by 4096. |
+--------------------+-------------------------------------------------------+
| nnnnnnnM | The number of megabytes. The nnnnnnn portion must be |
| | a decimal number that is multiplied by 1048576. |
+--------------------+-------------------------------------------------------+

Messages

ADDR001I Address [addr] is in region [regn]

The requested [address] is located in the specified


virtual storage region.

ADDR002W [cmdnm] command invalid with AR ON


The command is not valid in access register mode.

ADDR003W [cmdnm] command invalid with DAT OFF

The command is not valid with Dynamic Address Translation


set to off.
ALERTS

ALERTS Command

The ALERTS command displays MVS system data collection exception alerts.
Data collection values are displayed by the ALERTS command if the
current value exceeds a threshold definition.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Suggested Screen Size

This command is best viewed on a display with a screen size that is


greater than 80 columns.
Follow this link for more information: Dynamic screen sizes

The data contained in the display fields can be large.


The provided field formats have been ordered and sized to display the
information based on typical data. You are encouraged to create new
formats or alter the supplied field formats to meet your needs.

Command Syntax

+---------------+-----------------------------------------------------+
| ALERTs | [ [ WARNing | NORMal ] |
| | [ THRESH | ALL ] |
| | [ DETAIL | SUMMARY ] |
| | [ STATS | NOSTATS ] |
| | [ DESC | NODESC ] |
| | [ ACK | NOACK ] |
| | [ NOXSData | XSData ] |
| | [ NOXSYStem | XSYStem ] |
| | |
| | [ NAME name ] |
| | |
| | [ RSCESCope rscescope ] |
| | [ RSCENAme rscename ] |
| | [ RSCEQUal rscequal ] |
| | |
| | [ ALIAS alias ] |
| | [ ALTID altid ] |
| | [ METGRoup metgroup ] |
| | [ METSUBGroup metsubgroup ] |
| | [ SUMMGRP summgrp ] |
| | ] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| WARNING | Display entries with a status greater than |
| | Normal. This is the default. |
+------------------+--------------------------------------------------+
| NORMAL | Display entries with a status of Normal or |
| | greater. |
+------------------+--------------------------------------------------+
| THRESH | Display data for only those resources that have |
| | an associated threshold definition. |
+------------------+--------------------------------------------------+
| ALL | Display data for all collected resources. |
| | *Note - Use of this keyword can generate large |
| | amounts of data. |
+------------------+--------------------------------------------------+
| DETAIL | Display a separate entry showing the status |
| | of each defined threshold or state. |
+------------------+--------------------------------------------------+
| SUMMARY | Display a single entry for each collected metric |
| | showing the summarized status of each threshold |
| | definition. |
+------------------+--------------------------------------------------+
| STATS | Display data for all fields. |
+------------------+--------------------------------------------------+
| NOSTATS | Do not display data for the following fields: |
| | Current |
| | Average |
| | Median |
| | StdDev |
| | Warning |
| | Problem |
| | Minimum |
| | Maximum |
| | Distribution |
| | |
| | *Note - Use of this keyword is primarily used |
| | via API calls when the above data is |
| | not needed. |
+------------------+--------------------------------------------------+
| DESC | Display description for the metric. |
+------------------+--------------------------------------------------+
| NODESC | Do not display description for the metric. |
+------------------+--------------------------------------------------+
| ACK | Display acknowledged alerts. |
+------------------+--------------------------------------------------+
| NOACK | Do not display acknowledged alerts. |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross system data collection to be |
| XSData | set on for this execution of the command. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution of the command. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| name | Limit the display to only those entries with a |
| | corresponding value in the Name field. |
+------------------+--------------------------------------------------+
| rscescope | Limit the display to only those entries with a |
| | corresponding value in the RsceScope field. |
+------------------+--------------------------------------------------+
| rscename | Limit the display to only those entries with a |
| | corresponding value in the RsceName field. |
+------------------+--------------------------------------------------+
| rscequal | Limit the display to only those entries with a |
| | corresponding value in the RsceQual field. |
+------------------+--------------------------------------------------+
| alias | Limit the display to only those entries with a |
| | corresponding value in the Alias field. |
+------------------+--------------------------------------------------+
| altid | Limit the display to only those entries with a |
| | corresponding value in the AltID field. |
+------------------+--------------------------------------------------+
| metgroup | Limit the display to only those entries with a |
| | corresponding value in the Group field. |
+------------------+--------------------------------------------------+
| metsubgroup | Limit the display to only those entries with a |
| | corresponding value in the Subgroup field. |
+------------------+--------------------------------------------------+
| summgrp | Limit the display to only those entries with a |
| | corresponding value in the SummGrp field. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: Status,D,Pri,D,Name,A,RsceScope,A,RsceName,A,


RsceQual,A,XSSystem,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Name | The metric name for the data collection element. |
+------------------+--------------------------------------------------+
| Value | The value last used during threshold processing. |
| | If the resource does not currently have an |
| | associated threshold definition, the value is |
| | the last value collected by the data collector. |
+------------------+--------------------------------------------------+
| Status | The current threshold status. |
+------------------+--------------------------------------------------+
| RsceScope | The resource scope. |
+------------------+--------------------------------------------------+
| RsceName | The resource name. |
+------------------+--------------------------------------------------+
| RsceQual | The resource qualifier. |
+------------------+--------------------------------------------------+
| RsceAttr | The resource attribute type. |
+------------------+--------------------------------------------------+
| Alias | The alias for the resource scope or name. For |
| | example, if the metric name is address space |
| | specific, then resource scope contains the |
| | jobname and alias contains the ASID. |
+------------------+--------------------------------------------------+
| Pri | The relative priority of the exception. |
+------------------+--------------------------------------------------+
| Ack | Indicates the alert has been acknowledged. |
| | |
| | Possible values are: |
| | |
| | ACK - Alert has been acknowledged |
| | blank - Alert has not been acknowledged |
+------------------+--------------------------------------------------+
| RuleType | The exception rule type. |
| | |
| | Possible values are: |
| | |
| | UPPER - Upper limit threshold |
| | LOWER - Lower limit threshold |
| | ABOVE - Above limit threshold |
| | BELOW - Below limit threshold |
| | CHANGE - Change in value threshold |
| | STATE - State exception |
| | SUMMARY - Summarized entry |
| | |
| | For more information on these rule types see |
| | help topic Threshold and State Definitions |
+------------------+--------------------------------------------------+
| MetAlias | Data collection metric alias name. |
+------------------+--------------------------------------------------+
| Description | A description of the metric. |
+------------------+--------------------------------------------------+
| Current | The current value for the element over the last |
| | two minutes. |
+------------------+--------------------------------------------------+
| Average | The average value for the element over the last |
| | hour. |
+------------------+--------------------------------------------------+
| Median | The median value for the element over the last |
| | hour. |
+------------------+--------------------------------------------------+
| StdDev | The standard deviation for the element over the |
| | last hour. |
+------------------+--------------------------------------------------+
| Change | The difference between the duration average |
| | "Current" and the mean average "Average". |
+------------------+--------------------------------------------------+
| ChgStd | The "Change" value expressed as standard |
| | deviations. |
+------------------+--------------------------------------------------+
| Warning | The threshold limit value that the metric |
| | resource must reach to obtain the WARNING |
| | status. |
+------------------+--------------------------------------------------+
| Problem | The threshold limit value that the metric |
| | resource must reach to obtain the PROBLEM |
| | status. |
+------------------+--------------------------------------------------+
| Minimum | The minimum value for the element over the last |
| | hour. |
+------------------+--------------------------------------------------+
| Maximum | The maximum value for the element over the last |
| | hour. |
+------------------+--------------------------------------------------+
| Elapsed | The elapsed time that the metric has been in |
| | the current state or status. |
+------------------+--------------------------------------------------+
| Date | The date and time that the metric entered the |
| Time | current state or status. |
+------------------+--------------------------------------------------+
| AckElaps | The elapsed time since the alert has been |
| | acknowledged. |
+------------------+--------------------------------------------------+
| AckDate | The date and time that the alert was |
| AckTime | acknowledged. |
+------------------+--------------------------------------------------+
| Distribution | The distribution of values from minimum to |
| 0% ... 100% | maximum over the last hour separated into 11 |
| | buckets. Each bucket is equal to 1/10th of the |
| | maximum value. |
+------------------+--------------------------------------------------+
| AltID | The alternate ID. |
| | Contents for the following subgroup type: |
| | JOB - JES2 job ID |
+------------------+--------------------------------------------------+
| Group | The group classification. |
+------------------+--------------------------------------------------+
| Subgroup | The subgroup classification. |
+------------------+--------------------------------------------------+
| Pool | The name of the owning data collection pool. |
+------------------+--------------------------------------------------+
| Class | The internal data collection class name. |
+------------------+--------------------------------------------------+
| AckRsceScope | The resource scope used for acknowledgement. |
+------------------+--------------------------------------------------+
| AckRsceName | The resource name used for acknowledgement. |
+------------------+--------------------------------------------------+
| AckRsceQual | The resource qualifier used for acknowledgement. |
+------------------+--------------------------------------------------+
| SummGrp | The summarization group ID. |
+------------------+--------------------------------------------------+
| Policy | Exception policy token |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| ACK | Invokes the METSET command to acknowledge the alert. |
+----------+----------------------------------------------------------+
| CLR | Invokes the METSET command to clear an acknowledged |
| | alert. |
+----------+----------------------------------------------------------+

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| CList | Issues the CLIST command to invoke a user CLIST for the |
| | selected data collection metric. The user CLIST is used |
| | to provide additional information regarding the selected |
| | data collection element. Sample CLISTs are provided in |
| | the product CLISTLIB. |
| | |
| | The following CLIST command is issued: |
| | |
| | CLIST member ,, rscescope rscename rscequal alias |
| | |
| | member metric name (MetAlias field on display). |
| | If the metric name contains the |
| | character "%", it is translated to the |
| | letter "P" in order to generate a |
| | valid member name |
| | rscescope Passed as parameter 1 |
| | rscename Passed as parameter 2 |
| | rscequal Passed as parameter 3 |
| | alias Passed as parameter 4 |
+----------+----------------------------------------------------------+
| Graph | Issue the GRAPH command for the selected metric. |
+----------+----------------------------------------------------------+
| Log | Invokes the XLOG command to display the exception |
| | history of the selected metric. |
+----------+----------------------------------------------------------+
| METric | Invokes the METRICS command for the selected metric |
| | name. |
+----------+----------------------------------------------------------+
| MONitor | Invokes the MONRULES command selecting the definition |
| | that is currently associated with the alert. |
| | This monitor definition causes the metric to be |
| | monitored. |
+----------+----------------------------------------------------------+
| Plot | Issue the PLOT command for the selected metric. |
+----------+----------------------------------------------------------+
| RULe | Invokes the RULES command selecting the definition that |
| | is currently associated with the alert. |
+----------+----------------------------------------------------------+
| Select | Invokes the MOREINFO NOCLIST command for the selected |
| | metric. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
| OPTions | Set and display command options. |
+----------+----------------------------------------------------------+

OPTIONS Subcommand

Use the OPTIONS subcommand to set and display processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [options] |
+---------------+-----------------------------------------------------+
OPTIONS Parameter Values

The following table lists and explains the valid OPTIONS parameter
values. Any number of the values can be specified in any order.
The current settings of all options are always displayed in
response to the OPTIONS subcommand.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| Warning | Display only entries with a status level of Warning |
| | or greater. |
+---------------+-----------------------------------------------------+
| Normal | Display all entries. This includes entries with a |
| | status level of Normal or greater. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_ALERTS. EXTRACT is only valid |
| | when the product is running under a TSO CLIST or |
| | REXX exec. EXTRACT can be specified alone or in |
| | combination with any other OPTIONS keywords. |
+---------------+-----------------------------------------------------+
ALERTSUM

ALERTSUM Command

The ALERTSUM command displays a summarization or roll-up of current


exception alerts for all SYSVIEW components. A historical view
of the summarized alert status is available for the past 60 minutes.
The historic graph is summarized and updated once each minute.

Resource data rows without a data collection item count will be


excluded.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+---------------+-----------------------------------------------------+
| ALERTSUM | [ MODE OWNER ] |
| | [ OWNERRSCE ] |
| | [ INSTANCE ] |
| | [ RESOURCE ] |
| | |
| | [ SYSTEM ] |
| | [ MVS ] |
| | [ CICS ] [--owners |
| | [ IMS ] |
| | [ TCP ] |
| | [ MQ | WEBmq ] |
| | |
| | [ ACTive | INACTive ] |
| | |
| | [ GROUPS | NOGROUPS ] |
| | |
| | [ HISTGRAPHIC | HISTNUMERIC ] |
| | |
| | [ INSTANCE instance | ]group ] |
| | [ GROUPTYPE grptype ] |
| | [ RESOURCE resource ] |
| | |
| | [ NOXSDATA | XSDATA ] |
| | [ NOXSYSTEM | XSYSTEM ] |
| | |
+---------------+-----------------------------------------------------+

Parameters

If no "owners" are requested, then data rows will be displayed


for all available owner data including the system summary entry.

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| MODE | Specifies the summarization information that |
| | is to be displayed for the requested owners |
| | that currently have active alert summary data. |
| | |
| | OWNER - Display a single summary data row |
| | for each owner. |
| | |
| | If the owner has multiple child |
| | instances, the alert information |
| | is rolled-up into the owner |
| | summary data row. |
| | |
| | Defined logical groups will not |
| | be displayed. |
| | |
| | Fields: |
| | |
| | Owner = owner name |
| | Instance = * |
| | Resource = * |
| | |
| | ----------------------------------- |
| | |
| | OWNERRSCE - Display a single summary data row |
| | for each owner. |
| | |
| | Display a single data row for |
| | each resource summary group that |
| | is associated with the owner. |
| | |
| | If the owner has multiple child |
| | instances, the alert information |
| | is rolled-up into the owner |
| | summary data row and the summary |
| | resource data rows. |
| | |
| | Defined logical groups will not |
| | be displayed. |
| | |
| | Fields: |
| | |
| | Owner = owner name |
| | Instance = * |
| | Resource = resource summary group |
| | |
| | ----------------------------------- |
| | |
| | INSTANCE - Display a single summary data row |
| | for each owner. |
| | |
| | Display a single data row for |
| | each instance that summarizes |
| | any associated resource summary |
| | groups that are associated with |
| | the owner. |
| | |
| | By default, any defined logical |
| | groups will be displayed. |
| | |
| | Fields: |
| | |
| | Owner = owner name |
| | Instance = instance name |
| | Resource = * |
| | |
| | ----------------------------------- |
| | |
| | RESOURCE - Display a single summary data row |
| | for each owner. |
| | |
| | Display a single data row for |
| | each instance that summarizes |
| | any associated resource data rows. |
| | |
| | Display a data row for each |
| | resource associated with the |
| | instance. |
| | |
| | By default, any defined logical |
| | groups will be displayed. |
| | |
| | Fields: |
| | |
| | Owner = owner name |
| | Instance = instance name |
| | Resource = resource group |
| | |
+------------------+--------------------------------------------------+
| SYSTEM | Display summarized data row for the system |
| | |
| | Owner Instance Resource |
| | -------- -------- -------- |
| | SYSTEM * * |
| | |
| | The data row will always summarize ALL |
| | available alert information on the system. |
+------------------+--------------------------------------------------+
| MVS | Display alert summary info for: MVS |
| | |
| | Possible data rows based on MODE specified: |
| | |
| | Owner Instance Resource |
| | -------- -------- -------- |
| | MVS * * |
| | * rsce-1 |
| | * rsce-n |
+------------------+--------------------------------------------------+
| CICS | Display alert summary info for: CICS |
| | |
| | Possible data rows based on MODE specified: |
| | |
| | Owner Instance Resource |
| | -------- -------- -------- |
| | CICS * * |
| | * rsce-1 |
| | * rsce-n |
| | ]group-1 * |
| | ]group-1 rsce-1 |
| | ]group-1 rsce-n |
| | ]group-n * |
| | ]group-n rsce-1 |
| | ]group-n rsce-n |
| | job-1 * |
| | job-1 rsce-1 |
| | job-1 rsce-n |
| | job-n * |
| | job-n rsce-1 |
| | job-n rsce-n |
+------------------+--------------------------------------------------+
| IMS | Display alert summary info for: IMS |
| | |
| | Possible data rows based on MODE specified: |
| | |
| | Owner Instance Resource |
| | -------- -------- -------- |
| | IMS * * |
| | * rsce-1 |
| | * rsce-n |
| | ]group-1 * |
| | ]group-1 rsce-1 |
| | ]group-1 rsce-n |
| | ]group-n * |
| | ]group-n rsce-1 |
| | ]group-n rsce-n |
| | IMSID-1 * |
| | IMSID-1 rsce-1 |
| | IMSID-1 rsce-n |
| | IMSID-n * |
| | IMSID-n rsce-1 |
| | IMSID-n rsce-n |
+------------------+--------------------------------------------------+
| TCP | Display alert summary info for: TCP/IP |
| | |
| | Possible data rows based on MODE specified: |
| | |
| | Owner Instance Resource |
| | -------- -------- -------- |
| | TCP * * |
| | * rsce-1 |
| | * rsce-n |
| | ]group-1 * |
| | ]group-1 rsce-1 |
| | ]group-1 rsce-n |
| | ]group-n * |
| | ]group-n rsce-1 |
| | ]group-n rsce-n |
| | TCPID-1 * |
| | TCPID-1 rsce-1 |
| | TCPID-1 rsce-n |
| | TCPID-n * |
| | TCPID-n rsce-1 |
| | TCPID-n rsce-n |
+------------------+--------------------------------------------------+
| MQ | Display alert summary info for: IBM MQ |
| WEBmq | |
| | Possible data rows based on MODE specified: |
| | |
| | Owner Instance Resource |
| | -------- -------- -------- |
| | WEBMQ * * |
| | * rsce-1 |
| | * rsce-n |
| | ]group-1 * |
| | ]group-1 rsce-1 |
| | ]group-1 rsce-n |
| | ]group-n * |
| | ]group-n rsce-1 |
| | ]group-n rsce-n |
| | QMGR-1 * |
| | QMGR-1 rsce-1 |
| | QMGR-1 rsce-n |
| | QMGR-n * |
| | QMGR-n rsce-1 |
| | QMGR-n rsce-n |
+------------------+--------------------------------------------------+
| ACTIVE | Display data rows for resources with active |
| | data collection only. |
| | If collection has not been updated in the last |
| | 90 seconds, the instance will be considered |
| | inactive. |
+------------------+--------------------------------------------------+
| INACTIVE | Display data rows for active and inactive |
| | data collection resources. |
+------------------+--------------------------------------------------+
| GROUPS | Display data rows for defined logical groups. |
| | |
| | Defined logical groups will be displayed as a |
| | separate instance. Logical group entries are |
| | not rolled up into the owner entries. |
| | |
| | Logical groups will be displayed for the |
| | following modes: |
| | |
| | Mode |
| | -------- |
| | INSTANCE |
| | RESOURCE |
| | |
| | Owner Logical Group Type |
| | --------- -------------------------- |
| | CICS CICSPLEX |
| | IMS IMSID |
| | TCP TCPID |
| | WEBMQ MQQMGR |
| | |
+------------------+--------------------------------------------------+
| NOGROUPS | Do not display defined logical groups. |
+------------------+--------------------------------------------------+
| HISTGRAPHIC | Specifies the historical bar graph is to be |
| | displayed graphically. |
+------------------+--------------------------------------------------+
| HISTNUMERIC | Specifies the historical bar graph is to be |
| | displayed using numeric values. Each numeric |
| | value can be associated with a status condition. |
| | |
| | Possible values are: |
| | |
| | Value Status Condition |
| | ----- ---------------- |
| | 0 None |
| | 1 Normal |
| | 2 High |
| | 3 Warning |
| | 4 Problem |
| | 5 Unknown |
| | |
+------------------+--------------------------------------------------+
| INSTANCE | Specifies the instance name that is to be |
| | included in the display. The instance name |
| | can be specified as a logical group. |
| | |
| | Syntax: |
| | |
| | INSTANCE instance_name |
| | INSTANCE ]group |
| | |
| | The default logical group type for the |
| | instance name is JOBNAME. The list of |
| | instances may contain names other than |
| | true jobnames. |
| | |
| | Owner Instance Type |
| | --------- -------------------------- |
| | SYSTEM none |
| | MVS none |
| | CICS jobname |
| | IMS IMS subsystem ID |
| | TCP jobname of TCP/IP stack |
| | WEBMQ queue manager ID |
| | |
+------------------+--------------------------------------------------+
| GROUPTYPE | Specifies the logical group type to be used. |
| | The default type if not specified is JOBNAME. |
+------------------+--------------------------------------------------+
| RESOURCE | Specifies the resource name that is to be |
| | included in the display. |
| | This can be specified as a logical group. |
| | |
| | Syntax: RESOURCE resource |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross system data collection to be |
| XSData | set on for this execution of the command. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution of the command. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Mode | The current summarization mode. |
| | |
| | Possible values are: |
| | OWNER |
| | OWNERRSCE |
| | INSTANCE |
| | RESOURCE |
+------------------+--------------------------------------------------+
| Active | Indicator showing whether or not inactive |
| | resources will be displayed. |
| | |
| | Possible values are: |
| | ACTIVE |
| | INACTIVE |
+------------------+--------------------------------------------------+
| Instance | The current instance specified if any. |
+------------------+--------------------------------------------------+
| Resource | The current resource specified if any. |
+------------------+--------------------------------------------------+
| Group | The current logical group and group type |
| | specified if any. |
| | |
| | Possible values are: |
| | None |
| | group/grouptype |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Owner | The owner of the data collection metrics. |
| | |
| | Possible values are: |
| | SYSTEM - Summarization of all components |
| | MVS - z/OS |
| | CICS - CICS |
| | IMS - IMS |
| | TCP - TCP/IP |
| | WEBMQ - IBM MQ |
+------------------+--------------------------------------------------+
| Instance | The data collection instance name. |
| | SYSTEM - * |
| | MVS - * |
| | CICS - jobname |
| | IMS - IMS subsystem ID |
| | TCP - Jobname of TCP/IP stack |
| | WEBMQ - queue manager |
+------------------+--------------------------------------------------+
| Resource | The data collection resource group of metrics. |
+------------------+--------------------------------------------------+
| Normal | The number of data collection metrics that |
| | have been evaluated and have a current status |
| | of NORMAL based on threshold and state |
| | exception definitions. |
+------------------+--------------------------------------------------+
| High | The number of data collection metrics that |
| | have been evaluated and have a current status |
| | of HIGH based on threshold and state |
| | exception definitions. |
+------------------+--------------------------------------------------+
| Warning | The number of data collection metrics that |
| | have been evaluated and have a current status |
| | of WARNING based on threshold and state |
| | exception definitions. |
+------------------+--------------------------------------------------+
| Problem | The number of data collection metrics that |
| | have been evaluated and have a current status |
| | of PROBLEM based on threshold and state |
| | exception definitions. |
+------------------+--------------------------------------------------+
| Status | The highest status value for the resource |
| | group. |
+------------------+--------------------------------------------------+
| History | A historical view of the status value over the |
| | past 60 minutes. |
+------------------+--------------------------------------------------+
| None | The number of data collection metrics that |
| | have not been evaluated based on threshold |
| | or state exception definitions. A matching |
| | definition does not exist. |
+------------------+--------------------------------------------------+
| Items | The total number of data collection metrics |
| | that are being collected. |
+------------------+--------------------------------------------------+
| SummGrp | The summarization group ID. |
+------------------+--------------------------------------------------+
| LastDate | The date and time of the last triggered |
| LastTime | exception for the resource. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Select | Invokes the "alert" command for the selected resource |
| | group with a status greater than NORMAL. |
+----------+----------------------------------------------------------+
| ALL | Invokes the "alert" command for the selected resource |
| | group displaying all collected metrics regardless of |
| | status. |
+----------+----------------------------------------------------------+
| Normal | Invokes the "alert" command for the selected resource |
| | group with a status greater than or equal to NORMAL. |
+----------+----------------------------------------------------------+
| Instance | Invokes the ALERTSUM command with MODE INSTANCE |
| | displaying the available instances for the selected |
| | owner. |
+----------+----------------------------------------------------------+
| Resource | Invokes the ALERTSUM command with MODE RESOURCE |
| | displaying the available instances and resources for |
| | the selected owner and/or instance. |
+----------+----------------------------------------------------------+
| Metric | Invokes the METRICS command for the selected metric |
| | name. |
+----------+----------------------------------------------------------+
| Xlog | Invokes the XLOG command for the selected resource |
| | summary group displaying exception records from the |
| | prior hour. |
+----------+----------------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| OPTions | Set and display command options. |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC |
| | variable. The variable created or updated is |
| | named SYSV_OPTIONS_ALERTSUM. EXTRACT is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. EXTRACT can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+------------------+--------------------------------------------------+

OPTIONS Subcommand

Use the OPTIONS subcommand to set and display ALERTSUM command


display and processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [options] |
+---------------+-----------------------------------------------------+

OPTIONS Parameter Values

The following table lists and explains the valid OPTIONS parameter
values. Any number of the values can be specified in any order.
The current settings of all options are always displayed in
response to the OPTIONS subcommand.

+------------------+--------------------------------------------------+
| Value | Explanation |
+------------------+--------------------------------------------------+
| OWNER | Set the default display MODE to: OWNER |
| | |
| | Display a single summary data row |
| | for each owner. |
+------------------+--------------------------------------------------+
| OWNERRSCE | Set the default display MODE to: OWNERRSCE |
| | |
| | Display a single summary data row |
| | for each owner. |
| | |
| | Display a single data row for |
| | each resource summary group that |
| | is associated with the owner. |
| | |
| | If the owner has multiple child |
| | instances, the alert information |
| | is rolled-up into the owner |
| | summary data row and the summary |
| | resource data rows. |
+------------------+--------------------------------------------------+
| INSTANCE | Set the default display MODE to: INSTANCE |
| | |
| | Display a single summary data row |
| | for each owner. |
| | |
| | Display a single data row for |
| | each instance that summarizes |
| | any associated resource summary |
| | groups that are associated with |
| | the owner. |
+------------------+--------------------------------------------------+
| RESOURCE | Set the default display MODE to: RESOURC |
| | |
| | Display a single summary data row |
| | for each owner. |
| | |
| | Display a single data row for |
| | each instance that summarizes |
| | any associated resource data rows. |
| | |
| | Display a data row for each |
| | resource associated with the |
| | instance. |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC |
| | variable. The variable created or updated is |
| | named SYSV_OPTIONS_ALERTSUM. |
| | EXTRACT is only valid the product is running |
| | under a TSO CLIST or REXX exec. |
| | EXTRACT can be specified alone or in combination |
| | with any other OPTIONS keywords. |
+------------------+--------------------------------------------------+
ALLFILES

ALLFILES Command

The ALLFILES command includes the internal text file,


the sysin files, and all processed output files on the
LISTFILE, OUTPUT, and JOUTPUTW displays. When ALLFILES
is off, these files are not displayed.

Command Syntax

+---------------+------------------------------------------------------------+
| ALLFILES | [toggle] |
+---------------+------------------------------------------------------------+

Parameters

+------------------------------------------------------------+
| Use one toggle (Optional) |
+------------------------------------------------------------+
| ON |
| OFf |
+------------------------------------------------------------+

Toggle Parameter Values Explained

+---------------+------------------------------------------------------------+
| Toggle Value | Explanation |
+---------------+------------------------------------------------------------+
| ON | Includes all input and output files for a job displayed |
| | with the LISTFILE, OUTPUT, and JOUTPUTW commands. |
+---------------+------------------------------------------------------------+
| OFf | Turns ALLFILES off. This does not include all input and |
| | output files for a job displayed with the LISTFILE, |
| | OUTPUT, and JOUTPUTW commands. |
+---------------+------------------------------------------------------------+
ALLIST

ALLIST Command

The ALLIST command lists the contents of the access


lists of an address space.

Command Syntax

+---------------+------------------------------------------------------------+
| ALLIST | [asid] |
+---------------+------------------------------------------------------------+

Parameters

+----------------+-----------------------------------------------------------+
| Parameter | Explanation |
+----------------+-----------------------------------------------------------+
| asid | The ASID of the target address space. For details on |
| | specifying an ASID parameter, see the ASID command. If |
| | the ASID parameter is omitted, then the current ASID is |
| | used. |
+----------------+-----------------------------------------------------------+

Information Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Jobname | The current jobname. |
+---------------+------------------------------------------------------------+
| ASID | The current address space ID. |
+---------------+------------------------------------------------------------+
| Jobid | The job identifier. |
+---------------+------------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| LIST | The access list type. Valid values are: |
| | |
| | PASN-AL Primary address space number access list |
| | DU-AL Dispatchable unit access list |
| | |
+---------------+------------------------------------------------------------+
| Type | The space type represented by access list entry. Valid |
| | values are: |
| | |
| | ADDR Address space |
| | DATA Data space |
| | HIPE Hiperspace |
| | SUBS Subspace |
| | |
+---------------+------------------------------------------------------------+
| Jobname | The jobname of address space owning data space for type |
| | DATA. The jobname of the address space for type ADDR. |
+---------------+------------------------------------------------------------+
| ASID | The address space ID for the address space owning the data |
| | space for type DATA. The address space ID for type ADDR. |
+---------------+------------------------------------------------------------+
| DspName | The data space name for type DATA and HIPE. Otherwise |
| | blank. |
+---------------+------------------------------------------------------------+
| FO | FO when the access list entry is marked as fetch-only. |
| | Otherwise blank. |
+---------------+------------------------------------------------------------+
| P | P when the access list entry is marked as private. |
| | Otherwise blank. |
+---------------+------------------------------------------------------------+
| SN | The access list entry sequence number |
+---------------+------------------------------------------------------------+
| AX | The access list entry authorization index |
+---------------+------------------------------------------------------------+
| ASTEO | The ASTE origin (real address). |
+---------------+------------------------------------------------------------+
| ASTESN | The ASTE sequence number. |
+---------------+------------------------------------------------------------+
| ALET | The access list entry token. |
+---------------+------------------------------------------------------------+
| ALE | The access list entry address. |
+---------------+------------------------------------------------------------+
| TCB | The TCB address of the dispatchable unit for DU-AL list |
| | types. |
+---------------+------------------------------------------------------------+
| Al-Virt | The virtual address of the access list. |
+---------------+------------------------------------------------------------+
| Al-Real | The real address of the access list. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. |
+---------------+------------------------------------------------------------+
ALLOCAS

ALLOCAS Command

The ALLOCAS command displays allocated units. The information displayed


by the ALLOCAS command allows you to do the following:

* Review unit allocations without having to use command:


MVS D U,,ALLOC

* Determine which job has a particular unit allocated when that unit
is required by another job, or when it must be taken offline.

Command Syntax

+---------------+------------------------------------------------------------+
| ALLOCAS | [unittype][,devicenumber][,unitname][,volser][,status] |
+---------------+------------------------------------------------------------+

Parameters

+---------------+---------------+---------------+--------------+-------------+
| Use one | Use one | Use one | Use one | Use one |
| unittype | devicenumber | unitname | volser | status |
| (Optional) | (Optional) | (Optional) | (Optional) | (optional) |
+---------------+---------------+---------------+--------------+-------------+
| All | devicenumber | unitname | volser | ALL |
| Dasd | | | | ALLOc |
| TApe | | | | OFfline |
| Graphic | | | | ONline |
| Ur | | | | |
| TP | | | | |
| Ctc | | | | |
+---------------+---------------+---------------+--------------+-------------+

Unittype Parameter Values Explained

+----------------+-----------------------------------------------------------+
| Unittype Value | Explanation |
+----------------+-----------------------------------------------------------+
| All | All devices. All is the default. |
+----------------+-----------------------------------------------------------+
| Dasd | Direct access storage device. |
+----------------+-----------------------------------------------------------+
| TApe | Tape device. |
+----------------+-----------------------------------------------------------+
| Graphic | Display terminal. |
+----------------+-----------------------------------------------------------+
| Ur | Unit record device. |
+----------------+-----------------------------------------------------------+
| TP | Teleprocessing device. |
+----------------+-----------------------------------------------------------+
| Ctc | Channel-to-channel adapter. |
+----------------+-----------------------------------------------------------+

Devicenumber Parameter Values Explained


+-------------------+--------------------------------------------------------+
| Devicenumber Value| Explanation |
+-------------------+--------------------------------------------------------+
| devicenumber | The full or partial device hexadecimal address. |
| | Masking characters can be used. |
+-------------------+--------------------------------------------------------+

Unitname Parameter Values Explained

+----------------+-----------------------------------------------------------+
| Unitname Value | Explanation |
+----------------+-----------------------------------------------------------+
| unitname | The full or partial unit name. The unit name can be |
| | generic or esoteric. Masking characters can be used. |
+----------------+-----------------------------------------------------------+

Volser Parameter Values Explained

+----------------+-----------------------------------------------------------+
| Volser Value | Explanation |
+----------------+-----------------------------------------------------------+
| volser | The full or partial volume serial number. |
| | Masking characters can be used. |
+----------------+-----------------------------------------------------------+

Status Parameter Values Explained

+----------------+-----------------------------------------------------------+
| Status Value | Explanation |
+----------------+-----------------------------------------------------------+
| All | All status values. ALL is the default. |
+----------------+-----------------------------------------------------------+
| ALLOc | All allocated devices. |
+----------------+-----------------------------------------------------------+
| OFfline | All offline devices. |
+----------------+-----------------------------------------------------------+
| ONline | All online, or allocated devices. |
+----------------+-----------------------------------------------------------+

Information Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Units | The total units selected for the display. |
+---------------+------------------------------------------------------------+
| Allocations | The total allocations for all selected units. |
+---------------+------------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Type | The unit type. |
+---------------+------------------------------------------------------------+
| Devn | The device number. |
+---------------+------------------------------------------------------------+
| Unit | The unit name. |
+---------------+------------------------------------------------------------+
| Volser | The volume serial number, if the unit is a DASD or TAPE |
| | device. |
+---------------+------------------------------------------------------------+
| Status | The status of a device. |
| | Possible values are: |
| | |
| | ALLOC Allocated device |
| | |
| | ALLOC-P Allocated device with VARY OFFLINE pending |
| | |
| | ALLOC-X Device allocated to some external system. |
| | This is only possible for autoswitchable |
| | tape devices. |
| | |
| | OFFLINE Offline device |
| | |
| | ONLINE Online but unallocated device |
| | |
| | ONLIN-P Online with VARY OFFLINE pending |
| | |
| | UNAVAIL Offline and unavailable. |
| | This is only possible for tape devices. |
+---------------+------------------------------------------------------------+
| Count | The number of allocations for the unit. |
+---------------+------------------------------------------------------------+
| Jobname | The jobname that has the unit allocated. |
+---------------+------------------------------------------------------------+
| ASID | The address space ID that has the unit allocated. |
+---------------+------------------------------------------------------------+
| Jobct | The count of allocations the job has for the unit. |
+---------------+------------------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| ON | Issues the MVS VARY ONLINE command for the selected Devn. |
+---------------+------------------------------------------------------------+
| OFf | Issues the MVS VARY OFFLINE command for the selected Devn. |
+---------------+------------------------------------------------------------+
| FREe | Causes the device to be freed from the ASID to which it is |
| | allocated. This command is valid only for DASD devices. |
| | This command should be only be used when all the normal |
| | and standard methods for freeing a device from an ASID |
| | have failed. Unpredictable results occur if the ASID from |
| | which the device has been freed subsequently attempts I/O |
| | to the device or attempts to free the already freed |
| | device. You are prompted to confirm your intention to |
| | the device from the ASID if your CONFIRMDELETE option |
| | setting is YES. For more information see profile option |
| | SET CONFIRMDELETE |
+---------------+------------------------------------------------------------+
| Zap | Invokes the ZAP command for the selected DASD volume. |
+---------------+------------------------------------------------------------+
| ZRO | Invokes the ZAP command with the READONLY option for the |
| | selected DASD volume. |
+---------------+------------------------------------------------------------+
| ZRW | Invokes the ZAP command with the READWRITE option for the |
| | selected DASD volume. |
+---------------+------------------------------------------------------------+

Navigation Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| DASd | Invokes the DASD command for the selected DASD device. |
+---------------+------------------------------------------------------------+
| DSinfo | Invokes the DSINFO VTOC command to display information |
| Info | about the DASD volume. |
+---------------+------------------------------------------------------------+
| TAPe | Invokes the TAPE command for the selected TAPE device. |
+---------------+------------------------------------------------------------+
| UNIt | Invokes the UNIT command for the selected device. |
+---------------+------------------------------------------------------------+
| Space | Invokes the SPACE command for the selected volser. |
| Spc | |
+---------------+------------------------------------------------------------+
| Vtoc | Invokes the VTOC command for the selected volser. |
| Vtc | |
+---------------+------------------------------------------------------------+
| VCc | Invokes the VTOC command for the volser with the CHKCAT |
| | keyword. |
+---------------+------------------------------------------------------------+
| EXtents | Invokes the EXTENTS command for the selected volser. |
| Xtents | |
| Xtns | |
+---------------+------------------------------------------------------------+
| XCc | Invokes the EXTENTS command for the volser with the CHKCAT |
| | keyword. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. |
+---------------+------------------------------------------------------------+

Messages

ALLO001I Unit allocation status recording is not active

The MVS ALLOCAS address space is not currently active to perform


unit allocation status recording.

ALLO002E [linecmd] line command invalid, device is not allocated

Informational only.

ALLO003E [linecmd] line command invalid for status [stat]


Informational only.

ALLO004E [linecmd] line command invalid for type [typ]

Informational only.

ALLO005E [linecmd] line command invalid, device [devn] has no [var] paths

Informational only.

ALLO006E [linecmd] available only at MVS [mvslvl] or higher

Informational only.

ALLO007E Unit allocation status recording has failed

Unit allocation status recording has failed in the MVS ALLOCAS


address space.
ALLOCDS

ALLOCDS Command

The ALLOCDS command displays which data sets are allocated by which jobs
on a specific or generic DASD volume serial number.

Command Syntax

+---------------+------------------------------------------------------------+
| ALLOCDS | volser |
+---------------+------------------------------------------------------------+

Parameters

+---------------+------------------------------------------------------------+
| Values | Explanation |
+---------------+------------------------------------------------------------+
| volser | The specific or generic volume serial number for which |
| | data set allocations are desired. |
+---------------+------------------------------------------------------------+

Information Fields

+----------------+-----------------------------------------------------------+
| Field | Description |
+----------------+-----------------------------------------------------------+
| Volser | The volume serial number you specified on the command. |
| | This field is not displayed for specific volsers. |
+----------------+-----------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Volser | The volume serial number matching the specified volser |
| | parameter. |
+---------------+------------------------------------------------------------+
| Dataset-Name | The allocated data set name. |
+---------------+------------------------------------------------------------+
| Jobname | The jobname that has the data set allocated. |
+---------------+------------------------------------------------------------+
| DDname | The DD name to which the data set is allocated. |
+---------------+------------------------------------------------------------+
| IOCt | The count of IOs to the data set by the job. |
+---------------+------------------------------------------------------------+
| ASID | The ASID of the job. |
+---------------+------------------------------------------------------------+
| Stat | The data set status. |
| | Possible values are: |
| | |
| | MOD |
| | NEW |
| | OLD |
| | SHR |
+---------------+------------------------------------------------------------+
| NDisp | The normal disposition. |
| | Possible values are: |
| | |
| | CATLG |
| | DELET |
| | KEEP |
| | PASS |
| | UNCAT |
+---------------+------------------------------------------------------------+
| CDisp | The conditional disposition. |
| | Possible values are: |
| | |
| | CATLG |
| | DELET |
| | KEEP |
| | PASS |
| | UNCAT |
+---------------+------------------------------------------------------------+
| Org | The data set organization. |
| | Possible values are: |
| | |
| | DA |
| | IS |
| | PO |
| | PS |
| | VS |
+---------------+------------------------------------------------------------+
| Devn | The device number. |
+---------------+------------------------------------------------------------+
| Unit | The unit name. |
+---------------+------------------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Cancel | Invokes the MVS CANCEL command to cancel an address space. |
| CDump | The CDUMP command is used to cancel an address space with |
| | the DUMP option. For more information on the MVS CANCEL |
| | command, see the IBM System Commands manual. If the |
| | value of the SET CONFIRMDELET option is YES, then you are |
| | prompted to confirm your intention to cancel the selected |
| | address space. |
+---------------+------------------------------------------------------------+
| Edit | Invokes the EDIT command for the data set. |
+---------------+------------------------------------------------------------+
| FORce | Invokes the MVS FORCE command to force an address space. |
| | For more information on the MVS FORCE command, see the |
| | IBM System Commands manual. If the value of the |
| | SET CONFIRMDELET option is YES, then you are prompted to |
| | confirm your intention to force the selected address |
| | space. |
| | |
| | Indiscriminate use of the FORCE command can cause problems |
| | that require an IPL to fix. Be sure you understand all of |
| | the implications and warnings listed in the description of |
| | the MVS FORCE command listed in the IBM System Commands |
| | manual before using it. |
+---------------+------------------------------------------------------------+
| FREe | Frees the device from the selected ASID. This command |
| | should only be used when all the normal and standard |
| | methods for freeing a device from an ASID have failed. |
| | Unpredictable results occur if the ASID from which the |
| | device has been freed subsequently attempts I/O to the |
| | device or attempts to free the already freed device. You |
| | are prompted to confirm your intention to free the device |
| | from the ASID if your CONFIRMDELETE option setting is YES. |
| | For more information, see the SET CONFIRMDELETE keyword. |
+---------------+------------------------------------------------------------+
| KILl | Terminates an address space that could not be canceled or |
| | forced by using the CANCEL or FORCE commands described |
| | above. This command is even more dangerous than the FORCE |
| | command. Use it only as a last resort when all else has |
| | failed. |
| | |
| | If the value of the SET CONFIRMDELET option is YES, then |
| | you are prompted to confirm your intention to kill the |
| | selected address space. |
+---------------+------------------------------------------------------------+
| Zap | Invokes the ZAP command for the selected data set. |
+---------------+------------------------------------------------------------+
| ZRO | Invokes the ZAP command with the READONLY option for the |
| | selected data set. |
+---------------+------------------------------------------------------------+
| ZRW | Invokes the ZAP command with the READWRITE option for the |
| | selected data set. |
+---------------+------------------------------------------------------------+

Navigation Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Browse | Invokes the BROWSE command for the data set. |
+---------------+------------------------------------------------------------+
| DASd | Invokes the DASD command for the selected volume. |
+---------------+------------------------------------------------------------+
| DDList | Invokes the DDLIST command for the ddname within the ASID. |
+---------------+------------------------------------------------------------+
| DSAlloc | Invokes the DSALLOC command for the ASID. |
+---------------+------------------------------------------------------------+
| DSinfo | Invokes the DSINFO command for the data set. |
| Info | |
+---------------+------------------------------------------------------------+
| ENQueue | Invokes the ENQUEUE command specifying SYSDSN as the |
| NQ | qname and the selected data set name as the rname. |
+---------------+------------------------------------------------------------+
| EXtents | Invokes the EXTENTS command for the volser. |
| Xtents | |
| Xtns | |
+---------------+------------------------------------------------------------+
| LCat | Invokes the IDCAMS command to execute a LISTCAT command |
| | against the data set. |
+---------------+------------------------------------------------------------+
| Listdir | Invokes the LISTDIR command for the data set. |
| LDir | |
+---------------+------------------------------------------------------------+
| Space | Invokes the SPACE command for the volser. |
| Spc | |
+---------------+------------------------------------------------------------+
| View | Invokes the VIEW command for the data set. |
+---------------+------------------------------------------------------------+
| VToc | Invokes the VTOC command for the volser. |
| VTc | |
+---------------+------------------------------------------------------------+
| VCc | Invokes the VTOC command for volser with the CHKCAT |
| | keyword. |
+---------------+------------------------------------------------------------+
| XCc | Invokes the EXTENTS command for the volser with the CHKCAT |
| | keyword. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. |
+---------------+------------------------------------------------------------+

Messages

ALDS004E [linecmd] invalid, ASID [asid] has [attr] attribute

Informational only.

ALDS005W [linecmd] rejected, status of ASID [asid] has changed

Informational only.

ALDS006W [linecmd] rejected, try [altlinecmd] first

Informational only.

ALDS007W Insufficient storage available, data displayed is not complete

Insufficient storage was available to complete the ALLOCDS


command. Increasing your region size or specifying more
restricive parameters on the ALLOCDS command may allow the
command to complete successfully.
AMBLIST

AMBLIST Command

The AMBLIST command invokes the IBM AMBLIST utility


to format the contents of a load module or program
object.

Command Syntax

+---------------+-----------------------------------------------------+
| AMBlist | dsn(mbr) opts |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| dsn(mbr) | The dataset name and member to be listed. |
+------------------+--------------------------------------------------+
| opts | Any of the following options in any order. |
| | |
| | Xref Requests a module map and cross |
| | reference listing for a member |
| | of a load library or program |
| | object library. This is the |
| | default report type. |
| | |
| | Modlist Requests a listing of the module |
| | text and control information for |
| | a member of a load library or |
| | program object library. |
| | |
| | Both Requests both the XREF and MODLIST |
| | listing for a member of a load |
| | library or program object library. |
| | |
| | Adata Requests the display of all ADATA |
| | classes, if they exist, in a |
| | program object. The ADATA option |
| | is ignored when XREF is specified |
| | or defaulted to. |
| | |
| | Object Requests a listing of an object |
| | module. When OBJECT is specified |
| | all the above options are ignored. |
| | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Dsname | The current dataset name. |
+------------------+--------------------------------------------------+
| Member | The current member name. |
+------------------+--------------------------------------------------+

Data Fields

+---------------------------------------------------------------------+
| The data displayed by the AMBLIST command is the report output |
| generated by the IBM AMBLIST utility. |
+---------------------------------------------------------------------+

Messages

AMBL001E Dataset name and member name parameter required

Informational only.

AMBL002E Dsname [dsn] not cataloged

Informational only.

AMBL003E LOCATE for [dsn] failed, rc [rc]

Informational only.

AMBL004E Volume [vol] not mounted for [dsn]

Informational only.

AMBL005E Dsname [dsn] not found on [vol]

Informational only.

AMBL006E OBTAIN for [dsn] on [vol] failed, I/O error

Informational only.

AMBL007E OBTAIN for [dsn] on [vol] failed, rc [rc]

Informational only.

AMBL008E Dsname [dsn] not DSORG=PS or PO

Informational only.

AMBL009E Member name invalid when DSORG=PS

Informational only.

AMBL010E Member name required when DSORG=PO

Informational only.

AMBL011I AMBLIST complete, rc [rc]

Informational only.

AMBL012W AMBLIST complete, rc [rc]

Informational only.
AMBL013E AMBLIST complete, rc [rc]

Informational only.

AMBL015E Dsname required, no previous dsname available

Informational only.

AMBL016W Max lines exceeded, [count] line[s] discarded

Informational only.

AMBL017W Output incomplete, [limit] second cpu limit exceeded

Informational only.
APFLIST

APFLIST Command

The APFLIST command allows you to verify data set information in the
Authorized Program Facility (APF) list.

With the information displayed by the APFLIST command, you can do the
following:

* Verify the existence of APF-authorized data sets.

* Add data sets to the APF List using the ADD subcommand, without
having to IPL your system.

* Delete data sets from the APF List using the DELETE subcommand.

Command Syntax

+---------------+------------------------------------------------------------+
| APFlist | |
+---------------+------------------------------------------------------------+

Parameters

This command has no parameters.

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Dataset-Name | The data set name. |
+---------------+------------------------------------------------------------+
| Volser | The volume serial number where the data set resides. This |
| | field is blank if no volser was supplied in the IEAAPFxx |
| | member, indicating an SMS-managed data set. The volser |
| | of an SMS-managed data set may be set and highlighted |
| | after a VERIFY subcommand or line command if the volser |
| | was successfully retrieved from the catalog. |
+---------------+------------------------------------------------------------+
| Status | The data set and volser status. Valid values are: |
| | |
| | blank The status has not been determined. |
| | Issue the VERIFY line command to |
| | determine the status for a single data |
| | set/volser or issue the VERIFY |
| | subcommand to determine the status for |
| | all data sets and volsers. |
| | |
| | The following values are possible after a VERIFY line |
| | command or VERIFY subcommand: |
| | |
| | FOUND The data set was found on the |
| | volume. |
| | |
| | NOT_FOUND The data set was not found on |
| | the volume. |
| | |
| | NOT_FOUND/ The data set was not found on |
| | CATLG=xxxxxx the volume and xxxxx is the volume |
| | found in the catalog entry for the |
| | data set. |
| | |
| | NOT_MOUNTED The volume is not mounted. |
| | |
| | NOT_CATALOGED The volser for the data set |
| | indicated an SMS-managed data |
| | set but the data set is not |
| | cataloged. |
| | |
| | MIGRATED The volser for the data set |
| | indicated an SMS-managed data |
| | set but the data set is cataloged |
| | to a special volser that indicates |
| | the data set has been migrated or |
| | archived. |
| | |
| | OBTAIN_ERROR_xx An error occurred in the OBTAIN |
| | macro. The VERIFY check cannot be |
| | completed. xx is the return code |
| | from the OBTAIN macro. |
| | |
| | VTOC_I/O_ERROR An I/O error occurred reading the |
| | VTOC. The VERIFY check cannot be |
| | completed. |
| | |
| | LOCATE_ERROR_xx A LOCATE macro issued to determine |
| | the current volser failed. The |
| | VERIFY check cannot be completed. |
| | xx is the return code from the |
| | LOCATE macro. |
| | |
| | NOT_SMS_MGD The data set is not SMS-managed but |
| | the APFLIST entry specified an |
| | SMS-managed data set. |
| | |
| | SMS_MGD The data set is SMS-managed but the |
| | APFLIST entry specified a volser. |
| | |
| | ALIAS The data set name is an alias. |
| | |
| | The following values are possible after an ADD or |
| | DELETE line command: |
| | |
| | ADDED This value is displayed on the |
| | special .ADD.APFLIST.DATASET.NAME. |
| | line to show that the requested data |
| | set and volser has been successfully |
| | added. The .ADD.APFLIST.DATASET.NAME. |
| | input field is replaced with an |
| | output field containing the added |
| | data set name. The ADDVOL input |
| | field is replaced with an output |
| | field containing the added volser. |
| | The display must be refreshed with |
| | the REFRESH subcommand to return |
| | to the input fields with the newly |
| | added data set name and volser |
| | displayed in their correct order. |
| | |
| | DELETED This value is displayed on the line |
| | where a DELETE line command was |
| | entered to show that the requested |
| | data set and volser has been |
| | successfully deleted. The display |
| | must be refreshed with the REFRESH |
| | subcommand for the data set and |
| | volser to disappear. |
+---------------+------------------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| ADD | Add a new entry to the APF List. Enter this line command |
| | on the line displaying .ADD.APFLIST.DATASET.NAME. in the |
| | Dataset-Name field. Overtype the Dataset-Name field with |
| | the data set name to be added and overtype the ADDVOL |
| | value in the Volser field with the volser to be added. |
+---------------+------------------------------------------------------------+
| DELete | Delete the selected data set name and volser from the |
| | APF List. |
+---------------+------------------------------------------------------------+
| Zap | Invokes the ZAP command for the selected data set. |
+---------------+------------------------------------------------------------+
| ZRO | Invokes the ZAP command with the READONLY option for the |
| | selected data set. |
+---------------+------------------------------------------------------------+
| ZRW | Invokes the ZAP command with the READWRITE option for the |
| | selected data set. |
+---------------+------------------------------------------------------------+

Navigation Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Browse | Invokes the BROWSE command for the selected data set. |
+---------------+------------------------------------------------------------+
| DSinfo | Invokes the DSINFO command for the selected data set. |
| Info | |
+---------------+------------------------------------------------------------+
| ENQueue | Invokes the ENQUEUE command specifying SYSDSN as the |
| NQ | qname and the selected data set name as the rname. |
+---------------+------------------------------------------------------------+
| LCat | Invokes the IDCAMS command to execute a LISTCAT for the |
| | selected data set. |
+---------------+------------------------------------------------------------+
| Listdir | Invokes the LISTDIR command for the selected data set. |
| LDir | |
+---------------+------------------------------------------------------------+
| LMid | Invokes the LISTDIR command for the selected data set |
| | with the MODID keyword to display standard module |
| | identification information for all members in the data |
| | set. |
+---------------+------------------------------------------------------------+
| VErify | Verify the status of the selected data set name and |
| | volser. |
+---------------+------------------------------------------------------------+
| View | Invokes the VIEW command for the selected data set. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| ADD | Adds a data set to the APF List. |
+---------------+------------------------------------------------------------+
| DELETE | Deletes a data set from the APF List. |
+---------------+------------------------------------------------------------+
| REFRESH | Refreshes display data. |
+---------------+------------------------------------------------------------+
| VERIFY | Verifies that the data sets listed exist on the |
| | specified volumes. If you want to manipulate the |
| | display using the SELECT command on the Status field |
| | use the APFSTAT command. |
+---------------+------------------------------------------------------------+

ADD Subcommand

Use the ADD subcommand to add a data set to the APF List.

ADD Subcommand Format

+---------------+------------------------------------------------------------+
| ADD | dsname,volser |
+---------------+------------------------------------------------------------+

ADD Parameters Explained

+---------------+------------------------------------------------------------+
| Parameter | Description |
+---------------+------------------------------------------------------------+
| dsname | The name of the data set you want to add. Specify a |
| | fully qualified data set name by enclosing it in character |
| | delimiters. If you omit the character delimiters, then |
| | your data set name prefix is left appended to the data set |
| | name. For more information on data set name prefixes, see |
| | the SET DSNAMEPREFIX command. |
+---------------+------------------------------------------------------------+
| volser | The volume serial number where the data set resides. |
| | The following special volsers are also supported: |
| | |
| | SMSMGD Indicates that the data set name to be added |
| | SMS is an SMS-managed data set. When the data |
| | set is added to the APFLIST, the volser is |
| | displayed as blanks. |
| | |
| | ****** Requests that the SYSRES volser be used. |
| | |
| | * Requests that the cataloged volser for the |
| | specified dsname be used. If the specified |
| | dsname is an alias, the true name will be |
| | substituted. |
+---------------+------------------------------------------------------------+

ADD Confirmation

A confirmation message prompts you to confirm the ADD subcommand.


To confirm the ADD, enter YES at the command prompt.

DELETE Subcommand

Use the DELETE subcommand to delete a data set from the APF List.

DELETE Subcommand Format

+---------------+------------------------------------------------------------+
| DELETE | dsname,volser |
+---------------+------------------------------------------------------------+

DELETE Parameters Explained

+---------------+------------------------------------------------------------+
| Parameter | Description |
+---------------+------------------------------------------------------------+
| dsname | The name of the data set you want to delete. Specify a |
| | fully qualified data set name by enclosing it in character |
| | delimiters. If you omit the character delimiters, then |
| | your data set name prefix is left appended to the data set |
| | name. For more information on data set name prefixes, see |
| | the SET DSNAMEPREFIX command. |
+---------------+------------------------------------------------------------+
| volser | The volume serial number where the data set resides. |
| | The following special volsers are also supported: |
| | |
| | SMSMGD This volser is used to match an APFLIST |
| | SMS dsname that is SMS-managed and displays a |
| | volser of blanks. |
| | |
| | ****** Requests that the SYSRES volser be used. |
| | |
| | * Requests that the cataloged volser for the |
| | data set be used. |
+---------------+------------------------------------------------------------+

DELETE Confirmation

A confirmation message prompts you to confirm the DELETE subcommand.


To confirm the DELETE, enter YES at the command prompt.

VERIFY Subcommand

Use the VERIFY subcommand to verify that the data sets are listed on
the specified volumes.

VERIFY Subcommand Format

This subcommand has no parameters.


+---------------+------------------------------------------------------------+
| VERIFY | |
+---------------+------------------------------------------------------------+

Messages

APFL001I Processing started for [total] APF list entries

Informational only.

APFL002I Processing complete for [cmp] of [total] APF list entries

Informational only.

APFL003I Processing complete, elapsed time [elptime] cpu time [cputime]

Informational only.

APFL004I VERIFY complete - [errct] errors detected

The VERIFY subcommand completed and detected [errct] errors.

APFL005W Processing terminated by ATTN, APF list entry status incomplete

Informational only.

APFL006I Enter a valid [cmdname] command

Informational only.

APFL007E [dsname] [volser] already in table

The ADD subcommand was issued to add an entry to the APFLIST but the
specified entry already exists in the table.

APFL008E [dsname] [volser] not found

The DELETE subcommand was issued to delete an entry from the APFLIST
but the specified entry could not be found.

APFL009E [dsname] [volser] not deleteable

The DELETE subcommand was issued to delete an entry from the APFLIST
but the specified entry cannot validly be deleted.

APFL010I Processing started for [selct] of [total] selected APF list entries

Informational only.

APFL011I Processing complete for [cmp] of [selct] selected APF list entries

Informational only.

APFL012I Entry added - [dsname volser]

The dataset name [dsname] and the volser [volser] are successfully
added to APFLIST.

APFL013I Entry deleted - [dsname volser]


The dataset name [dsname] and the volser [volser] are successfully
deleted from APFLIST.

APFL014E [dsnm] not cataloged

Informational only.

APFL015E LOCATE failed - rc [rtcd]

Informational only.

APFL016E [cmnd] command invalid on line entered

Informational only.

APFL017E Dataset name required for [cmnd] command

Informational only.

APFL018E Invalid dataset name

Informational only.

APFL019E Volser required for [cmnd] command

Informational only.

APFL020E Invalid volser

Informational only.

APFL021E APFLIST format is not DYNAMIC

Informational only.

APFL022I [dsn] on [vol] is APF authorized

Informational only.

APFL023W [dsn] on [vol] is not APF authorized

Informational only.

APFL024I [dsn] on [vol] is APF authorized. [status]

The requested data set and volume have been verified


to be in the APF list. Additional data set and volume
information is provided via status.
APFSERV

APFSERV Command

The APFSERV command provides a set of services that


can take actions on the APF list.

Command Syntax

+------------------+--------------------------------------------------+
| APFSERV | function [parms] [options] |
+------------------+--------------------------------------------------+
| | Function and parameter syntax examples: |
| | |
| | Function Parameters |
| | ------------ ----------------------------------- |
| | ADD dsname volser [options] |
| | DELETE dsname volser [options] |
| | QUERY dsname volser |
| | VERIFY dsname volser |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| function | Requested function |
| | |
| | ADD - Add a new entry to the APF list |
| | |
| | DELETE - Delete an existing entry from the |
| | APF list |
| | |
| | QUERY - Determine if the requested pair |
| | TEST of data set name and volser are |
| | currently defined in the APF list. |
| | |
| | VERIFY - Determine if the requested pair |
| | of data set name and volser are |
| | currently defined in the APF list. |
| | Additionally validate the data set |
| | name and volser. |
| | |
+------------------+--------------------------------------------------+
| dsname | Data set name |
+------------------+--------------------------------------------------+
| volser | The volser associated with the data set name. |
| | |
| | The following special volsers are supported: |
| | |
| | SMSMGD - Indicates that the data set name |
| | SMS is an SMS-managed data set. |
| | |
| | ****** - Requests that the SYSRES volser be |
| | used. |
| | |
| | * - Requests that the cataloged volser |
| | for the specified dsname be used. |
| | If the specified dsname is an |
| | alias, the true name will be |
| | substituted. |
| | |
| | ' ' - If a blank volser is required, |
| | the volser must be entered as ' ' |
| | |
+------------------+--------------------------------------------------+
| options | Optional keyword parameters. Specify any number |
| | in any order from the following list: |
| | |
| | NOConfirm Controls whether you are |
| | Confirm prompted to confirm your |
| | intention. |
| | The default is CONFIRM. |
| | |
| | NOMessage Controls whether a "Command |
| | Message issued" message is generated |
| | generated at the successful |
| | completion of the command. |
| | The default is MESSAGE. |
| | |
+------------------+--------------------------------------------------+
APFSTAT

APFSTAT Command

The APFSTAT command displays the status of all data sets found in the
Authorized Program Facility (APF) list.

If you want to add or delete APF List entries then use the
APFLIST command.

Command Syntax

+---------------+------------------------------------------------------------+
| APFStat | [dsname] |
+---------------+------------------------------------------------------------+

Parameters

+---------------+------------------------------------------------------------+
| Values | Explanation |
+---------------+------------------------------------------------------------+
| dsname | A specific or generic data set name whose APF List status |
| | is to be displayed. The default is a single variable |
| | length mask character (by default "=") which displays |
| | the status of all APF List entries. |
+---------------+------------------------------------------------------------+

Information Fields

+----------------+-----------------------------------------------------------+
| Field | Description |
+----------------+-----------------------------------------------------------+
| Dsname | The data set name parameter in effect. |
+----------------+-----------------------------------------------------------+
| Total | The total number of APF List entries. |
+----------------+-----------------------------------------------------------+
| Selct | The number of APF List entries selected for display. |
+----------------+-----------------------------------------------------------+
| Found | The number of APF List entries displayed that have a |
| | Status field value of FOUND. |
+----------------+-----------------------------------------------------------+
| Error | The number of APF List entries displayed that have a |
| | Status field value other than FOUND. |
+----------------+-----------------------------------------------------------+
| NoCat | The number of APF List entries displayed that have a |
| | Status field value of NOT_CATALOGED. |
+----------------+-----------------------------------------------------------+
| NoMnt | The number of APF List entries displayed that have a |
| | Status field value of NOT_MOUNTED. |
+----------------+-----------------------------------------------------------+
| NoFnd | The number of APF List entries displayed that have a |
| | Status field value of NOT_FOUND. |
+----------------+-----------------------------------------------------------+
| Migrt | The number of APF List entries displayed that have a |
| | Status field value of MIGRATED. |
+----------------+-----------------------------------------------------------+
| NoSms | The number of APF List entries displayed that have a |
| | Status field value of NOT_SMS_MGD. |
+----------------+-----------------------------------------------------------+
| SmsNo | The number of APF List entries displayed that have a |
| | Status field value of SMS_MGD. |
+----------------+-----------------------------------------------------------+
| Alias | The number of APF List entries displayed that have a |
| | Status field value of ALIAS. |
+----------------+-----------------------------------------------------------+
| Other | The number of APF List entries displayed that have a |
| | Status field value of VTOC_IO_ERROR, OBTAIN_ERROR_xx, |
| | or LOCATE_ERROR_xx. |
+----------------+-----------------------------------------------------------+
| Unkwn | The number of APF List entries displayed that have a |
| | Status field value of UNKNOWN. |
+----------------+-----------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| DatasetName | The data set name. |
+---------------+------------------------------------------------------------+
| Volser | The volume serial number where the data set resides or |
| | blank if the data set is SMS-managed. |
+---------------+------------------------------------------------------------+
| Status | The data set status. Valid values are: |
| | |
| | FOUND The data set was found on the |
| | volume. |
| | |
| | NOT_FOUND The data set was not found on the |
| | volume. |
| | |
| | NOT_MOUNTED The volume is not mounted. |
| | |
| | NOT_CATALOGED The volser for the data set |
| | indicated an SMS-managed data set |
| | but the data set is not cataloged. |
| | |
| | MIGRATED The volser for the data set |
| | indicated an SMS-managed data |
| | set but the data set is cataloged |
| | to a special volser that indicates |
| | the data set has been migrated or |
| | archived. |
| | |
| | OBTAIN_ERROR_xx An error occurred in the OBTAIN |
| | macro. The status check cannot be |
| | completed. xx is the return code |
| | from the OBTAIN macro. |
| | |
| | VTOC_I/O_ERROR An I/O error occurred reading the |
| | VTOC. The status check cannot be |
| | completed. |
| | |
| | LOCATE_ERROR_xx A LOCATE macro issued to determine |
| | the current volser failed. The |
| | status check cannot be completed. |
| | xx is the return code from the |
| | LOCATE macro. |
| | |
| | NOT_SMS_MGD The data set is not SMS-managed but |
| | the APF list entry specified an |
| | SMS-managed data set. |
| | |
| | SMS_MGD The data set is SMS-managed but the |
| | APF list entry specified a volser. |
| | |
| | ALIAS The data set name is an alias. |
| | |
| | UNKNOWN The data set status could not be |
| | determined. |
+---------------+------------------------------------------------------------+
| CatVol | The cataloged volser if different than the Volser field. |
+---------------+------------------------------------------------------------+
| TrueName | The true name of the data set when the Status field value |
| | is ALIAS. |
+---------------+------------------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| DELete | Delete the selected data set name and volser from the |
| | APF List. |
+---------------+------------------------------------------------------------+
| Zap | Invokes the ZAP command for the selected data set. |
+---------------+------------------------------------------------------------+
| ZRO | Invokes the ZAP command with the READONLY option for the |
| | selected data set. |
+---------------+------------------------------------------------------------+
| ZRW | Invokes the ZAP command with the READWRITE option for the |
| | selected data set. |
+---------------+------------------------------------------------------------+

Navigation Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Browse | Invokes the BROWSE command for the selected data set. |
+---------------+------------------------------------------------------------+
| DSinfo | Invokes the DSINFO command for the selected data set. |
| Info | |
+---------------+------------------------------------------------------------+
| Edit | Invokes the EDIT command for the selected data set. |
+---------------+------------------------------------------------------------+
| ENQueue | Invokes the ENQUEUE command specifying SYSDSN as the |
| NQ | qname and the selected data set name as the rname. |
+---------------+------------------------------------------------------------+
| LCat | Invokes the IDCAMS command to execute a LISTCAT for the |
| | selected data set. |
+---------------+------------------------------------------------------------+
| Listdir | Invokes the LISTDIR command for the selected data set. |
| LDir | |
+---------------+------------------------------------------------------------+
| LMid | Invokes the LISTDIR command for the selected data set |
| | with the MODID keyword to display standard module |
| | identification information for all members in the data |
| | set. |
+---------------+------------------------------------------------------------+
| View | Invokes the VIEW command for the selected data set. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. Note that REFRESH refreshes the |
| | APFSTAT display for any active SELECT or SORT command but |
| | does not re-determine the status of the APF List data |
| | sets. To do that you must reissue the APFSTAT command. |
+---------------+------------------------------------------------------------+

Notes

* You can place the cursor on an information line header keyword and
hit the ENTER key to issue the following SELECT commands:

InfoKwd Command Issued


-------- ------------------------------
Total SELECT CLEAR
Selct SELECT CLEAR
Found SELECT STATUS EQ FOUND
Error SELECT STATUS NE FOUND
NoCat SELECT STATUS EQ NOT_CATALOGED
NoMnt SELECT STATUS EQ NOT_MOUNTED
NoFnd SELECT STATUS EQ NOT_FOUND
Migrt SELECT STATUS EQ MIGRATED
NoSms SELECT STATUS EQ NOT_SMS_MGD
SmsNo SELECT STATUS EQ SMS_MGD
Alias SELECT STATUS EQ ALIAS
Other SELECT STATUS CT ERROR
Unkwn SELECT STATUS EQ UNKNOWN

Messages

APFL001I Processing started for [total] APF list entries

Informational only.

APFL002I Processing complete for [cmp] of [total] APF list entries

Informational only.

APFL003I Processing complete, elapsed time [elptime] cpu time [cputime]

Informational only.

APFL004I VERIFY complete - [errct] errors detected


The VERIFY subcommand completed and detected [errct] errors.

APFL005W Processing terminated by ATTN, APF list entry status incomplete

Informational only.

APFL006I Enter a valid [cmdname] command

Informational only.

APFL007E [dsname] [volser] already in table

The ADD subcommand was issued to add an entry to the APFLIST but the
specified entry already exists in the table.

APFL008E [dsname] [volser] not found

The DELETE subcommand was issued to delete an entry from the APFLIST
but the specified entry could not be found.

APFL009E [dsname] [volser] not deleteable

The DELETE subcommand was issued to delete an entry from the APFLIST
but the specified entry cannot validly be deleted.

APFL010I Processing started for [selct] of [total] selected APF list entries

Informational only.

APFL011I Processing complete for [cmp] of [selct] selected APF list entries

Informational only.

APFL012I Entry added - [dsname volser]

The dataset name [dsname] and the volser [volser] are successfully
added to APFLIST.

APFL013I Entry deleted - [dsname volser]

The dataset name [dsname] and the volser [volser] are successfully
deleted from APFLIST.

APFL014E [dsnm] not cataloged

Informational only.

APFL015E LOCATE failed - rc [rtcd]

Informational only.

APFL016E [cmnd] command invalid on line entered

Informational only.

APFL017E Dataset name required for [cmnd] command

Informational only.

APFL018E Invalid dataset name


Informational only.

APFL019E Volser required for [cmnd] command

Informational only.

APFL020E Invalid volser

Informational only.

APFL021E APFLIST format is not DYNAMIC

Informational only.

APFL022I [dsn] on [vol] is APF authorized

Informational only.

APFL023W [dsn] on [vol] is not APF authorized

Informational only.

APFL024I [dsn] on [vol] is APF authorized. [status]

The requested data set and volume have been verified


to be in the APF list. Additional data set and volume
information is provided via status.
APFTEST

APFTEST Command

The APFTEST command tests the APF authorization status


of a data set and reports the result in a message.

Command Syntax

+---------------+-----------------------------------------------------+
| APFTest | dsname [volser] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| dsname | The name of the data set whose APF authorization |
| | status is to be tested. This parameter is |
| | required. |
+------------------+--------------------------------------------------+
| volser | The volser on which the data set resides. This |
| | parameter is optional. If omitted the cataloged |
| | volser will be used. |
+------------------+--------------------------------------------------+
APPLMON

APPLMON Command

The APPLMON command displays the availability summary of VTAM


applications monitored by the VTAM Application Monitor Task in
the SYSVIEW Main Services address space.

Definitions can be added or maintained here (warm start) or


in parmlib member APPLMON (cold start).

The data for this command requires the following to be active:

* VTAM Application Monitor - Task name APPLMON


* MVS Data Collector - Task name MVSDATA
* Scheduled Event function - MVSDATA-APPLIDS

Command Syntax

+---------------+-----------------------------------------------------+
| APPLMON | |
+---------------+-----------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+----------------------+----------------------------------------------+
| Field | Description |
+----------------------+----------------------------------------------+
| Monitor task status | The status of the VTAM application |
| | monitoring task that runs in the Main |
| | Services address space. |
+----------------------+----------------------------------------------+
| Monitor task appl | The VTAM APPL used by the monitor task to |
| | communicate with VTAM. |
+----------------------+----------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Appl | The VTAM APPL name of the application. |
+------------------+--------------------------------------------------+
| Status | The current application status. |
| | Possible values are: |
| | |
| | DUMMY A special line used to add new |
| | applications dynamically. |
| | |
| | Overtype the ?appl, ?jobname and |
| | ?description fields on this line |
| | to add applications to the table |
| | of monitored applications. |
| | |
| | ACTIVE The application is active. |
| | |
| | INACTIVE The application is inactive. |
| | |
| | INACTJOB The application is inactive and |
| | the associated jobname, if |
| | defined, is also inactive. |
| | |
| | NOLOGON The application does not accept |
| | logons. |
| | |
| | TMPNOLOG The application is temporarily not |
| | accepting logons. |
| | |
| | QUIESCE The application is quiescing. |
| | |
| | NOCONNCT The application is not connectable.|
| | |
| | NOTFOUND The application name is not known |
| | to VTAM. |
| | |
| | NOTAPPL The application name refers to an |
| | LU that is not session-capable. |
| | |
| | INITIAL The application name has just been |
| | added to the list of monitored |
| | applications but the status of the |
| | application has not yet been |
| | queried. |
| | |
+------------------+--------------------------------------------------+
| Avail | The overall availability of the application |
| | since monitoring started or over the last 24 |
| | hours, whichever is less. |
+------------------+--------------------------------------------------+
| AvalGraph | A graphical display of the overall availability |
| | of the application monitoring started or over |
| | the last 24 hours, whichever is less. |
+------------------+--------------------------------------------------+
| Jobname | The associated jobname for the application, if |
| | any, as specified in the APPLMON parmlib member. |
+------------------+--------------------------------------------------+
| Description | A description of the application. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Add | Add a new application. Overtype the ?appl value in the |
| | Appl field, the ?jobname value in the Jobname field, and |
| | the ?description value in the Description field to add a |
| | new application to be monitored. |
+----------+----------------------------------------------------------+
| DELete | Delete an existing application from the table of |
| | monitored applications. |
+----------+----------------------------------------------------------+

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| DISplay | Invoke the VTAM command to issue a D NET,ID=xxxxxxxx,E |
| | command for the selected appl name. |
+----------+----------------------------------------------------------+
| Select | Select the VTAM Application Monitor Detail display. |
| | This display shows the availability of the application |
| | by hour for the last 24 hours or since the VTAM |
| | application monitor task was last started, whichever is |
| | smaller. |
+----------+----------------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| EXPORT | Exports definitions to a specific member of |
| | a data set. |
| | |
| | Syntax: EXPORT member |
| | dsname(member) |
| | |
| | Parameter Description |
| | ---------- --------------------------------- |
| | member The name of the member to be |
| | saved. |
| | |
| | dsname The data set name where the |
| | specified member is saved. |
| | |
| | The data set name can be |
| | specified as a fully qualified |
| | data set name or using one of the |
| | following special keywords: |
| | |
| | Keyword Description |
| | ---------- ------------------------------- |
| | USER Uses the optional data set name |
| | defined in the user profile |
| | for the library type PARMLIB. |
| | |
| | Example: USER(member) |
| | |
| | SITE Uses the optional site PARMLIB |
| | data set that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITE(member) |
| | |
| | SYSTEM Uses the system PARMLIB data set |
| | that is defined in the system |
| | configuration options parmlib |
| | member: GSVXGSVX |
| | |
| | Example: SYSTEM(member) |
| | |
| | SITESYSTEM Uses the first defined data |
| | SITE.SYSTEM set from the following list |
| | * of eligible data set names: |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITESYSTEM(member) |
| | SITE.SYSTEM(member) |
| | *(member) |
| | |
| | USERSITE Uses the first defined data |
| | USER.SITE set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSITE(member) |
| | USER.SITE(member) |
| | |
| | USERSYSTEM Uses the first defined data |
| | USER.SYSTEM set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSYSTEM(member) |
| | USER.SYSTEM(member) |
| | |
| | The above keywords can be cursor selected |
| | invoking a hyperlink to the PARMLIB command |
| | showing the available data sets for the |
| | keyword. |
| | |
+------------------+--------------------------------------------------+
| SAVE | Save definitions to the persistent data store. |
+------------------+--------------------------------------------------+

Messages

APMN001E [linecmd] invalid on line entered

The line command that you entered is not valid on the line
on which you entered it.

APMN002E Appl required for [linecmd] line command

You entered the ADD line command but did not supply an application
name by overtyping the ?appl value in the Appl field.

APMN003E Invalid appl name

The application name you entered contained embedded blanks.


Correct the name and re-submit the command.

APMN004E [appl] is already being monitored

The application you are trying to add is already present in the


table of VTAM applications to be monitored.

APMN005E VTAM application monitor task is not active

The VTAM application monitor task has not been started.


For information on starting product tasks, see the
SYSVIEW Administrator Guide.

APMN006E VTAM application monitor table is full

The application monitor table is full and no more applications


can be added.

APMN007E Appl [appl] is not being monitored

You entered the APPLMOND command for an application that is not


being monitored. Use the APPLMON ADD line command to add the
application to the table of monitored applications.

APMN008E Invalid jobname

The value entered in the Jobname field contains embedded blanks


and is not a valid jobname.
APPLMOND

APPLMOND Command

The APPLMOND command displays the availability details


of a VTAM application monitored by the VTAM Application
Monitor Task of the main product address space.

Command Syntax

+---------------+-----------------------------------------------------+
| APPLMOND | appl |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| appl | The VTAM APPL name of the application. This |
| | application must be monitored by the VTAM |
| | Application Monitor Task of the main product |
| | address space. For more information, see the |
| | APPLMON command. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Appl | The VTAM APPL name of the application. |
+------------------+--------------------------------------------------+
| Status | The current application status. Valid values |
| | are: |
| | |
| | ACTIVE The application is active. |
| | |
| | INACTIVE The application is inactive. |
| | |
| | INACTJOB The application is inactive and |
| | the associated jobname, if |
| | defined, is also inactive. |
| | |
| | NOLOGON The application does not accept |
| | logons. |
| | |
| | TMPNOLOG The application is temporarily |
| | not accepting logons. |
| | |
| | QUIESCE The application is quiescing. |
| | |
| | NOCONNCT The application is not connectable.|
| | |
| | NOTFOUND The application name is not known |
| | to VTAM. |
| | |
| | NOTAPPL The application name refers to an |
| | LU that is not session-capable. |
| | |
+------------------+--------------------------------------------------+
| Avail | The overall availability of the application |
| | since monitoring started or over the last 24 |
| | hours, whichever is less. |
+------------------+--------------------------------------------------+
| Jobname | The associated jobname for the application, if |
| | any, as specified in the APPLMON parmlib member. |
+------------------+--------------------------------------------------+
| Description | A description of the application. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Time | The hour of the day to which the application |
| | availability percentage and graph apply. Only |
| | data for the last 24 hours is maintained. |
+------------------+--------------------------------------------------+
| Avail | The availability of the application in the hour |
| | indicated in the Time field. |
+------------------+--------------------------------------------------+
| AvalGraph | A graphical display of the availability of the |
| | application in the hour indicated in the Time |
| | field. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+

Messages

APMN001E [linecmd] invalid on line entered

The line command that you entered is not valid on the line
on which you entered it.

APMN002E Appl required for [linecmd] line command

You entered the ADD line command but did not supply an application
name by overtyping the ?appl value in the Appl field.

APMN003E Invalid appl name


The application name you entered contained embedded blanks.
Correct the name and re-submit the command.

APMN004E [appl] is already being monitored

The application you are trying to add is already present in the


table of VTAM applications to be monitored.

APMN005E VTAM application monitor task is not active

The VTAM application monitor task has not been started.


For information on starting product tasks, see the
SYSVIEW Administrator Guide.

APMN006E VTAM application monitor table is full

The application monitor table is full and no more applications


can be added.

APMN007E Appl [appl] is not being monitored

You entered the APPLMOND command for an application that is not


being monitored. Use the APPLMON ADD line command to add the
application to the table of monitored applications.

APMN008E Invalid jobname

The value entered in the Jobname field contains embedded blanks


and is not a valid jobname.
AR

AR Command

The AR command controls the access register (AR) mode


of the DISASSEM, DUMP, and MAP commands. When AR mode
is ON, dataspace virtual storage is displayed. When AR
mode is OFF, address space virtual storage is displayed.

If DAT mode is off, then AR mode is ignored and real


storage is displayed.

Command Syntax

+---------------+------------------------------------------------------------+
| AR | [toggle] |
+---------------+------------------------------------------------------------+

Parameters

+------------------------------------------------------------+
| Use one toggle (Optional) |
+------------------------------------------------------------+
| ON |
| OFf |
+------------------------------------------------------------+

Toggle Parameter Values Explained

+---------------+------------------------------------------------------------+
| Value | Explanation |
+---------------+------------------------------------------------------------+
| ON | Sets access register mode to ON if a dataspace has been |
| | previously set by the DSID command. |
+---------------+------------------------------------------------------------+
| OFf | Sets access register mode to OFF (primary mode). |
+---------------+------------------------------------------------------------+
ASADMIN

ASADMIN Command

The ASADMIN command displays information about the SYSVIEW address


spaces running on your system. It shows the status of the various
tasks running in those address spaces and provides line commands,
such as START and STOP, that allow you to control the task execution.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+---------------+-----------------------------------------------------+
| ASAdmin | [options] |
+---------------+-----------------------------------------------------+

Parameters

The following table lists and explains the valid ASADMIN options
parameter values. Any number of values can be specified in any order.
The options specified on the ASADMIN command are not saved from one
invocation of the ASADMIN command to the next. Options specified with
the OPTIONS subcommand are saved in your profile. These are then the
defaults that the ASADMIN options will override.

The defaults listed in the table below are the initial defaults. Your
defaults may be different if you have used the OPTIONS subcommand.

If you have tried various combinations of ASADMIN command options and


have arrived at a set that you would like to save as your defaults,
enter the OPTIONS subcommand with no operands. This will save the
current set of options as your defaults.

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| Cnfm | Controls whether user confirmation is requested |
| NOCnfm | prior to executing the STOP, SHUT, CANCEL, or |
| Confirm | FORCE line commands. Note that if you attempt |
| NOConfirm | to STOP the MAIN task, then you will receive the |
| | confirmation prompt regardless of the setting |
| | of this option. |
| | The default is CNFM. |
+------------------+--------------------------------------------------+
| SUmm | Controls whether or not the task summary data |
| NOSUmm | row is to be displayed. The task summary row |
| SUmmary | displays "*" for both the "Task" and "Id" fields.|
| NOSUmmary | The default is SUMM. |
+------------------+--------------------------------------------------+
| SErv | Controls whether or not SYSVIEW server address |
| NOSErv | spaces (also called the primary or main services |
| SErver | address space) are to be displayed. |
| NOSErver | The default is SERV. |
| PRImary | |
| NOPRImary | |
+------------------+--------------------------------------------------+
| User | Controls whether or not SYSVIEW user address |
| NOUser | spaces (also called secondary or user interface |
| SECondary | address spaces) are to be displayed. |
| NOSECondary | The default is USER. |
+------------------+--------------------------------------------------+
| Aux | Controls whether or not SYSVIEW auxiliary |
| NOAux | address spaces are to be displayed. |
| Auxiliary | The default is AUX. |
| NOAuxiliary | |
+------------------+--------------------------------------------------+
| SSid | Controls whether only SYSVIEW address spaces |
| NOSSid | that are using the same SSID as the current |
| | session are displayed (SSID) or all address |
| | spaces with any SSID are displayed (NOSSID). |
| | The default is NOSSID. |
+------------------+--------------------------------------------------+
| Rels | Controls whether only SYSVIEW address spaces |
| NORels | that are the same release as the current session |
| Release | are displayed (RELS) or all address spaces at |
| NORelease | any release are displayed (NORELS). |
| | The default is NORELS. |
+------------------+--------------------------------------------------+
| IJob | Controls whether or not inactive jobs are |
| NOIJob | displayed. The default is IJOB. |
| INACTJob | |
| NOINACTJob | |
| JOBInact | |
| NOJOBInact | |
+------------------+--------------------------------------------------+
| ITask | Controls whether or not inactive tasks are |
| NOITask | displayed. The default is ITASK. |
| INACTTask | |
| NOINACTTask | |
| TASKInact | |
| NOTASKInact | |
+------------------+--------------------------------------------------+
| Model | Controls whether or not model tasks are |
| NOModel | displayed. The default is MODEL. |
+------------------+--------------------------------------------------+
| XSdata | Controls whether or not cross system data |
| XSystem | collection is to be forced on or off for this |
| NOXSdata | execution. If none of these keywords are |
| NOXSystem | specified then the XSDATA profile setting will |
| | be used. The use of any of these keywords does |
| | not alter the XSDATA profile setting. Note that |
| | none of these keywords are supported on the |
| | ASADMIN command OPTIONS subcommand. |
+------------------+--------------------------------------------------+
| RESET | Resets all options to initial default values. |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable.|
| | The variable created or updated is named |
| | SYSV_OPTIONS_ASADMIN. This keyword is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. The EXTRACT keyword can be |
| | specified alone or in combination with any other |
| | keyword. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Options | Lists the current effective options. These |
| | options can be the original initial defaults, |
| | defaults overridden with the OPTIONS subcommand, |
| | or options specified on the ASADMIN command. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the product address space. |
+------------------+--------------------------------------------------+
| Task | The name of the task. |
+------------------+--------------------------------------------------+
| Id | The task identifier. |
+------------------+--------------------------------------------------+
| Status | The status of the task. |
| | |
| | Possible values are: |
| | |
| | INACTIVE The task is inactive. It is |
| | available to be started. |
| | |
| | ACTIVE The task is active. |
| | |
| | BUSY The task is busy. |
| | |
| | MODEL The task is a model for starting |
| | multiple instances of the same |
| | task name, each with a unique |
| | task identifier. |
| | |
| | STARTING A START command has been issued |
| | and the task is in the process of |
| | becoming active. |
| | |
| | STOPPING A STOP command has been issued |
| | and the task is in the process |
| | of stopping. |
| | |
| | SHUTTING A SHUT command has been issued |
| | and the task is in the process |
| | of shutting down. |
| | |
| | ABENDING A CANCEL or FORCE command has |
| | been issued and the task is in |
| | the process of abending. |
| | |
| | SUSPEND The task has been suspended |
| | by a SUSPEND command. |
| | |
+------------------+--------------------------------------------------+
| Parms | This is an input field where parameters can be |
| | supplied with the START and MODIFY commands. |
+------------------+--------------------------------------------------+
| Description | A description of the function of the task. |
+------------------+--------------------------------------------------+
| CpuTime | The total CPU time accumulated by the task. |
| | |
| | CpuTime = CPTime + EnclTime |
| | |
+------------------+--------------------------------------------------+
| Pct% | The percent of the total address space CPU time |
| | that has been consumed by the task. |
| | |
| | Pct% = CpuTime * 100 |
| | ---------------------- |
| | address space CPU time |
| | |
+------------------+--------------------------------------------------+
| CPTime | The accumulated task CPU time. |
+------------------+--------------------------------------------------+
| EnclTime | The accumulated enclave CPU time. |
+------------------+--------------------------------------------------+
| ePct% | The percent of the total CPU time used by the |
| | task that executed on an enclave. |
| | |
| | ePct% = EnclTime * 100 |
| | --------------------- |
| | CpuTime |
| | |
+------------------+--------------------------------------------------+
| zIIPTime | The accumulated enclave CPU time running on a |
| | zIIP processor. |
+------------------+--------------------------------------------------+
| zIIPonCP | The accumulated enclave CPU time that ran on a |
| | general processor that was eligible to run on a |
| | zIIP processor. |
+------------------+--------------------------------------------------+
| zPct% | The percent of the total CPU time used by the |
| | task that executed on a zIIP processor. |
| | |
| | zPct% = zIIPTime * 100 |
| | --------------------- |
| | CpuTime |
| | |
+------------------+--------------------------------------------------+
| TaskTime | The elapsed time since the task started. |
+------------------+--------------------------------------------------+
| WaitTime | The elapsed time since the task last waited for |
| | work. |
+------------------+--------------------------------------------------+
| CPUSec | The average CPU time used per second of elapsed |
| | time. |
+------------------+--------------------------------------------------+
| zSwitch | The number of zIIP mode switches. |
+------------------+--------------------------------------------------+
| zStart | The number of zIIP SRB starts. |
+------------------+--------------------------------------------------+
| zAsrv | The number of zIIP ALESERV requests. |
+------------------+--------------------------------------------------+
| zMode | The zIIP mode. |
| | |
| | Possible values are: |
| | |
| | blank The task has not been initialized |
| | for zIIP processing. |
| | |
| | TASK The task has been initialized for |
| | zIIP processing and is currently |
| | executing in TASK mode, not eligible |
| | for a zIIP processor. |
| | |
| | SRB The task has been initialized for |
| | zIIP processing and is currently |
| | executing in SRB mode, eligible for |
| | a zIIP processor. |
| | |
+------------------+--------------------------------------------------+
| STyp | The task start type. Values can be COLD or WARM. |
| | This value is displayed only for the following |
| | tasks that support a start type parameter: |
| | |
| | APPLMON VTAM application monitor task |
| | CICSDATA CICS data collector task |
| | IMSDATA IMS data collector task |
| | MQSDATA IBM MQ data collector task |
| | MVSDATA MVS data collector task |
| | SCHEDULR Scheduler task |
| | TCPDATA TCP/IP data collector task |
| | |
+------------------+--------------------------------------------------+
| StrDate | The date the task was last started. |
+------------------+--------------------------------------------------+
| StrTime | The time the task was last started. |
+------------------+--------------------------------------------------+
| EndDate | The date the task last ended. This is blank if |
| | the task is currently active. |
+------------------+--------------------------------------------------+
| EndTime | The time the task last ended. This is blank if |
| | the task is currently active. |
+------------------+--------------------------------------------------+
| Features | The list of required features to start the task. |
| | |
| | If multiple features are specified, only one is |
| | required to be enabled to start the task. |
| | |
| | If "blank", no features are required. |
| | |
| | Features shown in uppercase are enabled. |
| | Features shown in lowercase are not enabled. |
| | |
| | List of enabled features |
| | |
+------------------+--------------------------------------------------+
| SWI | The task restart wait interval in seconds. This |
| | value determines how long to wait before |
| | re-attaching a subtask that is eligible for |
| | restart after it has terminated. |
+------------------+--------------------------------------------------+
| SSq | The task start sequence number. This number is |
| | used during address space initialization to |
| | determine the relative order in which the tasks |
| | are to be started. |
+------------------+--------------------------------------------------+
| ESq | The task end sequence number. This number is |
| | used during address space termination to |
| | determine the relative order in which the tasks |
| | are to be stopped. |
+------------------+--------------------------------------------------+
| T-Stg | Total storage allocated. |
+------------------+--------------------------------------------------+
| B-Stg | Storage allocated below 16M. |
+------------------+--------------------------------------------------+
| A-Stg | Storage allocated above 16M and below 2G. |
+------------------+--------------------------------------------------+
| EAStg | The estimated amount of storage that will be |
| | allocated above 16M and below 2G. This value |
| | is used to control the starting of subtasks |
| | based on the amount of unallocated storage |
| | available above 16M and below 2G. |
+------------------+--------------------------------------------------+
| G-Stg | Storage allocated above 2G. |
+------------------+--------------------------------------------------+
| T-Hwm | Total storage allocated high water mark. |
+------------------+--------------------------------------------------+
| B-Hwm | Storage allocated below 16M high water mark. |
+------------------+--------------------------------------------------+
| A-Hwm | Storage allocated above 16M and below 2G high |
| | water mark. |
+------------------+--------------------------------------------------+
| G-Hwm | Storage allocated above 2G high water mark. |
+------------------+--------------------------------------------------+
| G-Fmx | Largest free block available above 2G. |
+------------------+--------------------------------------------------+
| G-Siz | Storage pool size above 2G. |
+------------------+--------------------------------------------------+
| G-Pri | Primary storage allocation above 2G. |
+------------------+--------------------------------------------------+
| G-Sec | Secondary storage allocation above 2G. |
+------------------+--------------------------------------------------+
| G-Lim | Storage limit above 2G. |
+------------------+--------------------------------------------------+
| Typ | The type of address space. |
| | |
| | Possible values are: |
| | |
| | PRI Primary server |
| | AUX Auxiliary server |
| | SEC Secondary user interfaces |
| | |
+------------------+--------------------------------------------------+
| PstCt | Posted for work count. |
+------------------+--------------------------------------------------+
| RPELast | The request processing elapsed time for the last |
| | (most recent) wait-to-post interval. |
+------------------+--------------------------------------------------+
| RPEThrsh | The elapsed time threshold for a request |
| | processing post-to-wait interval. If this |
| | threshold is exceeded then a message will be |
| | written to the console indicating that this |
| | threshold was exceeded. |
+------------------+--------------------------------------------------+
| RPEEx | The number of times the elapsed time request |
| | processing threshold was exceeded. |
+------------------+--------------------------------------------------+
| RPCLast | The request processing CPU time for the last |
| | (most recent) wait-to-post interval. |
+------------------+--------------------------------------------------+
| RPCThrsh | The CPU time threshold for a request |
| | processing post-to-wait interval. If this |
| | threshold is exceeded then a message will be |
| | written to the console indicating that this |
| | threshold was exceeded. |
+------------------+--------------------------------------------------+
| RPCEx | The number of times the CPU time request |
| | processing threshold was exceeded. |
+------------------+--------------------------------------------------+
| UsrC | The user count. The number of users or instances |
| | of the task. |
+------------------+--------------------------------------------------+
| StrC | The start count. This is the number of times |
| | the task has been started. |
+------------------+--------------------------------------------------+
| RstC | The restart count. This is the number of times |
| | the task has been automatically restarted after |
| | terminating abnormally. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| ASID | Address space identifier. |
+------------------+--------------------------------------------------+
| SSid | Subsystem identifier. |
+------------------+--------------------------------------------------+
| Rels | Release. |
+------------------+--------------------------------------------------+
| Bld | Build number. |
+------------------+--------------------------------------------------+
| DsP | Dispatch priority. |
+------------------+--------------------------------------------------+
| LmP | Limit priority. |
+------------------+--------------------------------------------------+
| Pri | PRI if PRIMARY address space is required. |
+------------------+--------------------------------------------------+
| Jes | JES if JES2 is required. |
+------------------+--------------------------------------------------+
| Usc | USC for user session controller task. |
+------------------+--------------------------------------------------+
| Sup | SUP for supervisor state task. |
+------------------+--------------------------------------------------+
| Mul | MUL if multiple tasks are allowed. |
+------------------+--------------------------------------------------+
| Lcs | LCS if lowercase parameters are supported. |
+------------------+--------------------------------------------------+
| Prs | PRS if MODIFY command parameters must be parsed. |
+------------------+--------------------------------------------------+
| Stt | STT if the STATUS command is supported. |
+------------------+--------------------------------------------------+
| Shu | SHU if the SHUT command is supported. |
+------------------+--------------------------------------------------+
| Mod | MOD if the MODIFY command is supported. |
+------------------+--------------------------------------------------+
| Rst | RST if the RESTART command is supported. |
+------------------+--------------------------------------------------+
| Gnq | GNQ if a global ENQ is required. |
+------------------+--------------------------------------------------+
| Lnq | LNQ if a local ENQ is required. |
+------------------+--------------------------------------------------+
| Mdl | MDL for MODEL task table entry. |
+------------------+--------------------------------------------------+
| Mnt | MNT for MAIN task. |
+------------------+--------------------------------------------------+
| Ssz | SSZ if share subpool zero is required. |
+------------------+--------------------------------------------------+
| Usr | USR if the USERS line command is supported. |
+------------------+--------------------------------------------------+
| Sec | SEC if SECONDARY address space is required. |
+------------------+--------------------------------------------------+
| Ast | AST if the task is automatically started. |
+------------------+--------------------------------------------------+
| Idr | IDR if a taskid is required to start the task. |
+------------------+--------------------------------------------------+
| Qmc | QMC if MODIFY commands are to be queued. |
+------------------+--------------------------------------------------+
| Stp | STP if the start type parameter is supported. |
+------------------+--------------------------------------------------+
| Aux | AUX if AUXILIARY address space is allowed. |
+------------------+--------------------------------------------------+
| Sdw | Shutdown wait interval in seconds. |
+------------------+--------------------------------------------------+
| CodO | Offset into the main anchor block of the task's |
| | state code. |
+------------------+--------------------------------------------------+
| EcbO | Offset into the main anchor block of the task's |
| | global request queue ECB. |
+------------------+--------------------------------------------------+
| ReqO | Offset into the main anchor block of the task's |
| | global request queue head of chain address. |
+------------------+--------------------------------------------------+
| AidO | Offset into the main anchor block of the task's |
| | ASID. |
+------------------+--------------------------------------------------+
| CpuMon | The CPU time used monitoring state. |
| | |
| | Possible values are: |
| | |
| | blank Not supported |
| | DISABL Disabled |
| | INACTV Inactive |
| | ACTIVE Active |
| | SUSPND Suspended |
| | UNKNWN Unknown |
| | |
+------------------+--------------------------------------------------+
| CpuLimit | The limit of consecutive CPU time allowed. |
| | This is the CPU time the task is allowed to use |
| | before it gives up control of the CPU. If the |
| | task exceeds this value, it will be abended with |
| | a U0017-1. |
| | This value is taken from the CpuTimeLimit |
| | parameter of the OPTIONS parmlib member. |
+------------------+--------------------------------------------------+
| CpuMax | The maximum consecutive CPU time the task has |
| | actually used. |
+------------------+--------------------------------------------------+
| RRL | Recovery/retry level. |
+------------------+--------------------------------------------------+
| Module | The name of the module. |
+------------------+--------------------------------------------------+
| EpAddr | The module entry point address. |
+------------------+--------------------------------------------------+
| TCB | The TCB address. |
+------------------+--------------------------------------------------+
| TSKE | The TSKE address. |
+------------------+--------------------------------------------------+
| COMM | The COMM address. |
+------------------+--------------------------------------------------+
| DSA | The DSA address. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Output | Invokes the OUTPUT command for the selected jobname. |
+----------+----------------------------------------------------------+
| Start | Starts an inactive or model task. A task ID may be |
| | specified by entering it in the ID field. Parameters |
| | may be specified in the Parms field. |
+----------+----------------------------------------------------------+
| Restart | Restarts an inactive task. |
+----------+----------------------------------------------------------+
| STOp | Stops an active task, or the entire address space if it |
| P | is issued on the MAIN task line. |
+----------+----------------------------------------------------------+
| MODify | Submits a MODIFY command to the selected task. |
| F | Parameters are entered in the Parms field. |
+----------+----------------------------------------------------------+
| Cancel | Cancels an active task. Include the DUMP keyword to |
| [Dump] | request that a dump also be taken. The default is to |
| | cancel a task without taking a dump. |
+----------+----------------------------------------------------------+
| Users | Invokes the USERS command to display the active user |
| | sessions for the task. |
+----------+----------------------------------------------------------+
| SHUt | Shuts down an active user interface controller task such |
| | as VTAM or CICS. The task does not end until all active |
| | users have terminated their sessions. Use the STOP line |
| | command to perform an immediate shutdown. |
+----------+----------------------------------------------------------+
| SUSPend | Suspends an active task. A suspended task is active but |
| | not dispatchable. |
+----------+----------------------------------------------------------+
| RESUme | Resumes a suspended task, making it dispatchable again. |
+----------+----------------------------------------------------------+
| Listlog | Invokes the LISTLOG command for the selected jobname |
| | and task. |
+----------+----------------------------------------------------------+
| MQMsglog | Invokes the MQMSGLOG command for the selected jobname |
| | and task. |
+----------+----------------------------------------------------------+
| STG | Displays the storage allocations for the task. |
+----------+----------------------------------------------------------+
| any | Any valid primary command can be issued as an ASADMIN |
| valid | line command. If the specified command is a memory |
| primary | switch sensitive command (such as DUMP or JPA), then an |
| command | ASID command is internally generated to switch to the |
| | selected address space before invoking the requested |
| | command. If the specified command supports a jobname |
| | and jobnumber parameter as the first two parameters |
| | (such as OUTPUT and STEPSUM) and no other parameters |
| | were entered in the line command input area, then the |
| | requested command is invoked with the jobname and number |
| | from the selected address space. All other commands |
| | are invoked as if they had been entered in the primary |
| | command input area. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
| OPTIONS | Set and display ASADMIN options. |
+----------+----------------------------------------------------------+

OPTIONS Subcommand

The OPTIONS subcommand is used to set and display ASADMIN command


processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [options] |
+---------------+-----------------------------------------------------+

The following table lists and explains the valid OPTIONS parameter
values. Any number of values can be specified in any order. The
current settings of all options are displayed in the information
area. Options changed with the OPTIONS subcommand are saved in your
profile as the default options for the ASADMIN command. These defaults
can be overridden by specifying the same option keywords on the
ASADMIN command. Options changed in this manner are not saved.

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| Cnfm | Controls whether user confirmation is requested |
| NOCnfm | prior to executing the STOP, SHUT, CANCEL, or |
| Confirm | FORCE line commands. Note that if you attempt |
| NOConfirm | to STOP the MAIN task, then you will receive the |
| | confirmation prompt regardless of the setting |
| | of this option. |
| | The default is CNFM. |
+------------------+--------------------------------------------------+
| SUmm | Controls whether or not the task summary data |
| NOSUmm | row is to be displayed. The task summary row |
| SUmmary | displays "*" for both the "Task" and "Id" fields.|
| NOSUmmary | The default is SUMM. |
+------------------+--------------------------------------------------+
| SErv | Controls whether or not SYSVIEW server address |
| NOSErv | spaces (also called the primary or main services |
| SErver | address space) are to be displayed. |
| NOSErver | The default is SERV. |
| PRImary | |
| NOPRImary | |
+------------------+--------------------------------------------------+
| User | Controls whether or not SYSVIEW user address |
| NOUser | spaces (also called secondary or user interface |
| SECondary | address spaces) are to be displayed. |
| NOSECondary | The default is USER. |
+------------------+--------------------------------------------------+
| Aux | Controls whether or not SYSVIEW auxiliary |
| NOAux | address spaces are to be displayed. |
| Auxiliary | The default is AUX. |
| NOAuxiliary | |
+------------------+--------------------------------------------------+
| SSid | Controls whether only SYSVIEW address spaces |
| NOSSid | that are using the same SSID as the current |
| | session are displayed (SSID) or all address |
| | spaces with any SSID are displayed (NOSSID). |
| | The default is NOSSID. |
+------------------+--------------------------------------------------+
| Rels | Controls whether only SYSVIEW address spaces |
| NORels | that are the same release as the current session |
| Release | are displayed (RELS) or all address spaces at |
| NORelease | any release are displayed (NORELS). |
| | The default is NORELS. |
+------------------+--------------------------------------------------+
| IJob | Controls whether or not inactive jobs are |
| NOIJob | displayed. The default is IJOB. |
| INACTJob | |
| NOINACTJob | |
| JOBInact | |
| NOJOBInact | |
+------------------+--------------------------------------------------+
| ITask | Controls whether or not inactive tasks are |
| NOITask | displayed. The default is ITASK. |
| INACTTask | |
| NOINACTTask | |
| TASKInact | |
| NOTASKInact | |
+------------------+--------------------------------------------------+
| Model | Controls whether or not model tasks are |
| NOModel | displayed. The default is MODEL. |
+------------------+--------------------------------------------------+
| RESET | Resets all options to initial default values. |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable.|
| | The variable created or updated is named |
| | SYSV_OPTIONS_ASADMIN. This keyword is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. The EXTRACT keyword can be |
| | specified alone or in combination with any other |
| | keyword. |
+------------------+--------------------------------------------------+

Messages

ASAD002E [linecmd] line command invalid for [tasknm] task

Informational only.

ASAD003E [linecmd] line command invalid for status [errstat]

Informational only.

ASAD004E [linecmd] line command does not support parameters

Informational only.

ASAD005E Invalid task id

Informational only.

ASAD006E Task id is already in use

Informational only.

ASAD007E Task [tasknm] with id [taskid] is already active - Specify an id

Informational only.

ASAD008E [linecmd] invalid, job [jobnm] ASID [asid] has [attr] attribute

Informational only.

ASAD009W [linecmd] rejected, try [altcmd] first

Informational only.

ASAD010W [linecmd] rejected, status of ASID [asid] has changed

Informational only.

ASAD011W No user sessions for [taskid] task

Informational only.

ASAD012E [lcmd] line command invalid, [tsknam] task has never been started

Informational only.

ASAD013E Id parm required to start task [taskname]

Informational only.

ASAD014W [linecmd] line command invalid for task summary row

Informational only.
ASCANCEL

ASCANCEL Command

The ASCANCEL command is used to cancel an address space.


The ASCANCEL command invokes the MVS CANCEL command.
For more information on the MVS CANCEL command, see the
IBM System Commands manual. The ASCANCEL command is
rejected if the target address space is non-cancelable.
The ASLIST command can be used to check the non-cancelable
attribute of an address space.

Command Syntax

+---------------+-----------------------------------------------------+
| ASCANcel | asid [JOBname jobname] [TYPE astype] [opts] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| asid | The ASID parameter identifies the address space |
| | to be canceled. The ASID parameter can be |
| | specified using one of the following forms: |
| | |
| | hexasid A hexadecimal ASID specified as |
| | 1 to 4 hexadecimal digits. |
| | |
| | decasid A decimal ASID specified as 1 to |
| | 5 decimal digits followed by a |
| | decimal point. |
| | |
| | identifier A 1 to 8 character started task |
| | identifier. For started tasks |
| | that are started using the |
| | format "procname.identifier". |
| | |
| | jobname A 1 to 8 character jobname. The |
| | jobname must be enclosed |
| | character delimiters if it would |
| | otherwise be recognized as a |
| | hexadecimal ASID. |
| | |
| | jobnumber A 1 to 7 character JES job |
| | number with a "J" prefix. The |
| | job number can be for a batch |
| | job, a TSO user, or a started |
| | task. |
| | |
| | jobid A 1 to 5 character JES job |
| | number prefixed by "JOB", "TSU", |
| | or "STC", for batch jobs, TSO |
| | users, and started tasks, |
| | respectively. The prefix used |
| | must match the prefix of the |
| | actual job. |
| | |
+------------------+--------------------------------------------------+
| JOBname jobname | The JOBNAME parameter must be specified when |
| | the asid parameter is a hexasid or decasid. |
| | |
| | The job name is used to verify and ensure a |
| | match with the job name executing in the |
| | specified asid. |
| | |
| | The JOBNAME parameter will be ignored for |
| | asid parameters other than hexasid or decasid. |
| | |
+------------------+--------------------------------------------------+
| TYPE astype | The TYPE parameter can only be specified |
| | when the asid parameter is a job name. |
| | |
| | It is used to restrict the possible match |
| | to a specific address space type. The astype |
| | value must be one of the following keywords: |
| | |
| | ANY Any address space type. |
| | This is the default. |
| | ATX An APPC transaction. |
| | INIT An initiator. |
| | JOB A batch job. |
| | OTX An OMVS transaction. |
| | STC A started task. |
| | SYS A system task. |
| | TSU A TSO user. |
| | |
+------------------+--------------------------------------------------+
| opts | Optional keyword parameters. Specify any number |
| | in any order from the following list: |
| | |
| | NODump Controls whether a dump is |
| | Dump requested. |
| | The default is DUMP. |
| | |
| | NORestart Controls whether a job restart |
| | Restart is requested through the |
| | services of the MVS Automatic |
| | Restart Manager. |
| | The default is NORESTART. |
| | |
| | NOConfirm Controls whether you are |
| | Confirm prompted to confirm your |
| | intention. |
| | The default is CONFIRM. |
| | |
| | NOMessage Controls whether a "Command |
| | Message issued" message is generated |
| | generated at the successful |
| | completion of the command. |
| | The default is MESSAGE. |
| | |
| | The default values for the options listed above |
| | can be changed using the ASOPTION command. The |
| | defaults listed here are the original default |
| | values as the product is distributed. |
| | |
| | MVS Controls whether the requested |
| | JES cancel command is issued via |
| | an MVS cancel or a JES cancel |
| | command. |
| | |
| | If neither MVS or JES is |
| | specified, the method is |
| | determined by the option |
| | ASCancelJobWithJesCommand |
| | that is specified in the |
| | parmlib member OPTIONS |
| | |
+------------------+--------------------------------------------------+
ASCANTSK

ASCANTSK Command

The ASCANTSK command is used to cancel a task within an


address space.

Command Syntax

+---------------+-----------------------------------------------------+
| ASCANTsk | asid tcbaddr [JOBname jobname] [TYPE astype] [opts] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| asid | The ASID parameter identifies the address space |
| | in which the task to be canceled is active. |
| | The ASID parameter can be specified using one |
| | of the following forms: |
| | |
| | * The current target address space |
| | |
| | hexasid A hexadecimal ASID specified as |
| | 1 to 4 hexadecimal digits |
| | |
| | decasid A decimal ASID specified as 1 to |
| | 5 decimal digits followed by a |
| | decimal point |
| | |
| | jobname A 1- to 8-character jobname. |
| | The jobname must be enclosed |
| | character delimiters if it would |
| | otherwise be recognized as a |
| | hexadecimal ASID. |
| | |
| | jobnumber A 1- to 5-character JES job |
| | number prefixed with a J. The |
| | job number can be for a batch |
| | job, a TSO user, or a standard |
| | task. |
| | |
| | jobid A 1- to 5-character JES job |
| | number prefixed by JOB, TSU, or |
| | STC, for batch jobs, TSO users, |
| | and started tasks, respectively. |
| | The prefix used must match the |
| | prefix of the actual job. |
| | |
+------------------+--------------------------------------------------+
| tcbaddr | The TCB address of the task to be canceled. |
| | |
| | Follow this hyperlink for address parameter |
| | information. If a TCB address of 0 is |
| | specified, then the jobstep task is canceled. |
+------------------+--------------------------------------------------+
| JOBname jobname | The JOBNAME parameter must be specified when |
| | the asid parameter is a hexasid or decasid. |
| | |
| | The job name is used to verify and ensure a |
| | match with the job name executing in the |
| | specified asid. |
| | |
| | The JOBNAME parameter will be ignored for |
| | asid parameters other than hexasid or decasid. |
| | |
+------------------+--------------------------------------------------+
| TYPE astype | The TYPE parameter can only be specified |
| | when the asid parameter is a job name. |
| | |
| | It is used to restrict the possible match |
| | to a specific address space type. The astype |
| | value must be one of the following keywords: |
| | |
| | ANY Any address space type. |
| | This is the default. |
| | ATX An APPC transaction. |
| | INIT An initiator. |
| | JOB A batch job. |
| | OTX An OMVS transaction. |
| | STC A started task. |
| | SYS A system task. |
| | TSU A TSO user. |
| | |
+------------------+--------------------------------------------------+
| opts | Optional keyword parameters. Specify any |
| | number in any order from the following list: |
| | |
| | NODump Controls whether a dump is |
| | Dump requested. The default is |
| | DUMP. |
| | |
| | NOConfirm Controls whether you are |
| | Confirm prompted to confirm your |
| | intention. The default is |
| | CONFIRM. |
| | |
| | NOMessage Controls whether a "Command |
| | Message issued" message is generated at |
| | the successful completion of |
| | the command. The default is |
| | MESSAGE. |
| | |
| | The default values for the options listed above |
| | may be changed using the ASOPTION command. The |
| | defaults listed here are the original default |
| | values as the product is distributed. |
| | |
+------------------+--------------------------------------------------+
ASEXTRAC

ASEXTRAC Command

The ASEXTRAC command is used to extract identifying


information about an address space into a TSO CLIST
or REXX EXEC variable. The variable created by this
command is named SYSV_ASID and contains the blank
delimited ASID, job name, job identifier and address
space type. If the address space does not have a job
identifier, then the value n/a is used instead. The
ASEXTRAC command is valid only when SYSVIEW is
executing under the control of a TSO CLIST or REXX
EXEC.

Command Syntax

+---------------+-----------------------------------------------------+
| ASEXTrac | [asid] [TYPE astype] [opts] [infokwd] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| asid | The ASID parameter identifies the address space |
| | to be extracted. The ASID parameter can be |
| | specified using one of the following forms: |
| | |
| | hexasid A hexadecimal ASID specified as |
| | 1 to 4 hexadecimal digits |
| | |
| | decasid A decimal ASID specified as 1 to |
| | 5 decimal digits followed by a |
| | decimal point |
| | |
| | jobname A 1- to 8-character jobname. |
| | The jobname must be enclosed |
| | character delimiters if it would |
| | otherwise be recognized as a |
| | hexadecimal ASID. |
| | |
| | jobnumber A 1- to 5-character JES job |
| | number prefixed with a J. The |
| | job number can be for a batch |
| | job, a TSO user, or a started |
| | task. |
| | |
| | jobid A 1- to 5-character JES job |
| | number prefixed by JOB, TSU, or |
| | STC, for batch jobs, TSO users, |
| | and started tasks, respectively. |
| | The prefix used must match the |
| | prefix of the actual job. |
| | |
| | * The current target address |
| | space. |
| | |
| | keyword A keyword from the following |
| | list: |
| | |
| | CUrr The current target |
| | address space. |
| | |
| | Home The home address |
| | space. |
| | |
| | Next The next active |
| | address space after |
| | the current target |
| | address space. |
| | |
| | Prev The previous active |
| | address space before |
| | the current target |
| | address space. |
| | |
| | FIrst The first active |
| | address space. |
| | |
| | Last The last active |
| | address space. |
| | |
| | The current target ASID is used as a default if |
| | the ASID parameter is omitted. |
| | |
+------------------+--------------------------------------------------+
| TYPE astype | The TYPE parameter can only be specified when |
| | the asid parameter is a job name or the FIRST, |
| | NEXT, PREVIOUS, or LAST keywords. |
| | |
| | It is used to restrict the possible match |
| | to a specific address space type. The astype |
| | value must be one of the following keywords: |
| | |
| | ANY Any address space type. |
| | This is the default. |
| | ATX An APPC transaction. |
| | INIT An initiator. |
| | JOB A batch job. |
| | OTX An OMVS transaction. |
| | STC A started task. |
| | SYS A system task. |
| | TSU A TSO user. |
| | |
+------------------+--------------------------------------------------+
| opts | Optional keyword parameters. Specify any |
| | number in any order from the following list: |
| | |
| | NOMessage Controls whether a "Variable |
| | Message created" message is generated |
| | at the successful completion |
| | of the command. The default is |
| | MESSAGE. |
| | |
| | The default values for the options listed above |
| | may be changed using the ASOPTION command. The |
| | defaults listed here are the original default |
| | values as the product is distributed. |
| | |
+------------------+--------------------------------------------------+
| infokwd | Query information request keyword. |
| | |
| | Can be one of the following values. If more |
| | than one is specified only the last will be |
| | used. |
| | |
| | If none of these values are specified then just |
| | the basic ASID information is displayed. |
| | The basic information is the ASID, Jobname, |
| | Jobid, and address space type for the requested |
| | asid parameter. |
| | |
| | DPRTY Dispatch priority. |
| | |
| | EPVTLIMIT Extended private region |
| | size limit. |
| | |
| | MEMLIMIT Memory limit on the total |
| | number of virtual storage |
| | pages above the bar. |
| | |
| | SERVICECLASS Service class name. |
| | |
| | QUIESCED Quiesced indicator. |
| | |
| | DESCRIPTION Jobname description. |
| | Descriptions are obtained |
| | from the JOBNAMES parmlib |
| | member. |
| | |
+------------------+--------------------------------------------------+
ASFETCH

ASFETCH Command

The ASFETCH command displays information about the fetching


and unfetching of modules. The fetch statistics are for the
current job step of an active address space.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| ASFETCH | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYSTEM | This forces cross system data collection to be |
| XSDATA | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYSTEM | This forces cross system data collection to be |
| NOXSDATA | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,ASID,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| ASID | The hexadecimal address space ID. |
| | |
| | Note: If the ASID value is 0000, the data |
| | displayed on the row is the total |
| | requests since monitoring was started. |
+------------------+--------------------------------------------------+
| Jobname | The name of the job. |
| | |
| | Note: If the Jobname value is '*TOTAL', the data |
| | displayed on the row is the total |
| | requests since monitoring was started. |
+------------------+--------------------------------------------------+
| Type | The type of job. Valid values are: |
| | |
| | JOB A batch job |
| | SYS A system task |
| | STC A started task |
| | TSU A TSO user |
| | INI An initiator |
| | ATX An APPC transaction |
| | OTX An OpenMVS transaction |
+------------------+--------------------------------------------------+
| Stepname | The current stepname. Stepnames are displayed |
| | only for jobs that have a stepname coded in the |
| | JCL. |
+------------------+--------------------------------------------------+
| Count | The total number of requests. |
+------------------+--------------------------------------------------+
| FetchGet | Fetch get requests. |
| | The module was not on the job pack queue so a |
| | new copy was loaded. |
+------------------+--------------------------------------------------+
| FetchJPQ | Fetch JPQ requests. |
| | The module was already on the job pack queue |
| | so an existing copy was used. |
+------------------+--------------------------------------------------+
| FetchLPA | Fetch LPA requests |
+------------------+--------------------------------------------------+
| FetchDir | Fetch directed load requests |
+------------------+--------------------------------------------------+
| UnixGet | Unix get requests. |
| | The module was not on the job pack queue so a |
| | new copy was loaded. |
+------------------+--------------------------------------------------+
| UnixJPQ | Unix JPQ requests. |
| | The module was already on the job pack queue |
| | so an existing copy was used. |
+------------------+--------------------------------------------------+
| UnixDir | Unix directed load requests |
+------------------+--------------------------------------------------+
| Fork | Fork requests |
+------------------+--------------------------------------------------+
| UFetchFree | Unfetch free requests. |
| | There were no remaining users of the module. |
| | The module storage was freed. |
+------------------+--------------------------------------------------+
| UFetchNoFree | Unfetch no free requests. |
| | There were remaining users of the module. |
| | The module storage was not freed. |
+------------------+--------------------------------------------------+
| UFetchLPA | Unfetch LPA requests |
+------------------+--------------------------------------------------+
| Procstep | The current procedure stepname. Procedure |
| | stepnames are displayed only for jobs that use a |
| | PROC statement in the JCL. |
+------------------+--------------------------------------------------+
| JobStat | The status of the job. Valid values are: |
| | NS Nonswappable |
| | LSW Logically swapped |
| | GO OUT Currently being swapped out |
| | GO IN Currently being swapped in |
| | IN Swapped in |
| | OUT TO Swapped out--terminal output wait |
| | OUT TI Swapped out--terminal input wait |
| | OUT LW Swapped out--long wait |
| | OUT XS Swapped out--auxiliary storage |
| | shortage |
| | OUT RS Swapped out--real storage shortage |
| | OUT DW Swapped out--detected wait |
| | OUT RQ Swapped out--requested swap |
| | OUT NQ Swapped out--enqueue exchange swap |
| | OUT EX Swapped out--exchange on recommended |
| | value |
| | OUT US Swapped out--unilateral swap |
| | OUT TS Swapped out--transition swap |
| | OUT IC Swapped out--improve central storage |
| | OUT IP Swapped out--improve system paging |
| | OUT MR Swapped out--make room |
| | OUT AW Swapped out--APPC wait |
| | OUT OI Swapped out--input wait |
| | OUT OO Swapped out--output wait |
| | OUT LS Swapped out--logical swap |
| | OUT LF Swapped out--logical swap fail |
| | OUT SR Swapped out--real swap |
| | blank No address space found with the |
| | specified jobname |
+------------------+--------------------------------------------------+
| Jobnr | The job number. |
+------------------+--------------------------------------------------+
| JobClass | The job input class. Only batch jobs have a job |
| | input class. |
+------------------+--------------------------------------------------+
| Description | A description of the address space based on the |
| | jobname. The description for a jobname is |
| | defined in the parmlib member JOBNAMES. |
+------------------+--------------------------------------------------+
| ASCB | The ASCB address for the job. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| LF | Invokes the LISTFILE command for the selected |
| | jobname and job number. |
+------------------+--------------------------------------------------+
| JJobque | Invokes the JJOBQUE command for the selected |
| LJ | jobname. |
+------------------+--------------------------------------------------+
| SS | Invokes the STEPSUM command for the selected |
| | jobname and job number. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
ASFORCE

ASFORCE Command

The ASFORCE command is used to force an address space.


The ASFORCE command invokes the MVS FORCE command. For
more information on the MVS FORCE command, see the IBM
System Commands manual. The ASFORCE command is rejected
if the target address space has the non-memtermable
attribute. The ASLIST command can be used to check the
non-memtermable attribute of an address space. The ASFORCE
command is also rejected if the target address space is
cancelable and you have not yet tried to terminate the
address space with the ASCANCEL command.

Indiscriminate use of the ASFORCE command can cause problems


that require an IPL to fix. Be sure you understand all of
the implications and warnings listed in the description of
the MVS FORCE command listed in the IBM System Commands
manual before using ASFORCE.

Command Syntax

+---------------+-----------------------------------------------------+
| ASFORce | asid [JOBname jobname] [TYPE astype] [opts] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| asid | The ASID parameter identifies the address space |
| | to be forced. The ASID parameter can be |
| | specified using one of the following forms: |
| | |
| | hexasid A hexadecimal ASID specified |
| | as 1 to 4 hexadecimal digits. |
| | |
| | decasid A decimal ASID specified as 1 |
| | to 5 decimal digits followed |
| | by a decimal point. |
| | |
| | jobname A 1 to 8 character jobname. |
| | The jobname must be enclosed |
| | character delimiters if it |
| | would otherwise be recognized |
| | as a hexadecimal ASID. |
| | |
| | jobnumber A 1 to 5 character JES job |
| | number prefixed with a "J". |
| | The job number can be for a |
| | batch job, a TSO user, or a |
| | started task. |
| | |
| | jobid A 1 to 5 character JES job |
| | number prefixed by "JOB", "TSU", |
| | or "STC", for batch jobs, TSO |
| | TSO users, and started tasks, |
| | respectively. The prefix used |
| | must match the prefix of the |
| | actual job. |
| | |
+------------------+--------------------------------------------------+
| JOBname jobname | The JOBNAME parameter must be specified when |
| | the asid parameter is a hexasid or decasid. |
| | |
| | The job name is used to verify and ensure a |
| | match with the job name executing in the |
| | specified asid. |
| | |
| | The JOBNAME parameter will be ignored for |
| | asid parameters other than hexasid or decasid. |
| | |
+------------------+--------------------------------------------------+
| TYPE astype | The TYPE parameter can only be specified |
| | when the asid parameter is a job name. |
| | |
| | It is used to restrict the possible match |
| | to a specific address space type. The astype |
| | value must be one of the following keywords: |
| | |
| | ANY Any address space type. |
| | This is the default. |
| | ATX An APPC transaction. |
| | INIT An initiator. |
| | JOB A batch job. |
| | OTX An OMVS transaction. |
| | STC A started task. |
| | SYS A system task. |
| | TSU A TSO user. |
| | |
+------------------+--------------------------------------------------+
| opts | Optional keyword parameters. Specify any number |
| | in any order from the following list: |
| | |
| | NORestart Controls whether a job restart |
| | Restart is requested through the |
| | services of the MVS Automatic |
| | Restart Manager. |
| | The default is NORESTART. |
| | |
| | NOConfirm Controls whether you are |
| | Confirm prompted to confirm your |
| | intention. |
| | The default is CONFIRM. |
| | |
| | NOMessage Controls whether a "Command |
| | Message issued" message is generated |
| | at the successful completion |
| | of the command. |
| | The default is MESSAGE. |
| | |
| | The default values for the options listed above |
| | can be changed using the ASOPTION command. The |
| | defaults listed here are the original default |
| | values as the product is distributed. |
| | |
+------------------+--------------------------------------------------+
ASID

ASID Command

The ASID command changes the current target address space and the
current target data space, process ID (PID) and TCB within that
address space.

The current target address space is referenced by any command that


displays information for a particular address space (commands that
use the ASID parameter).

Command Syntax

+------------------+--------------------------------------------------+
| | |
| ASID | [asid[.dspname] [options] [TYPE astype] |
| | [PID pid ] |
| | [TCB tcb ]] |
| | |
+------------------+--------------------------------------------------+

+----------------+---------+--------+-------------+-------------------+
| asid | dspname | option | TYPE astype | PID pid | TCB tcb |
+----------------+---------+--------+-------------+-------------------+
| hexadecimal | dspname | SWitch | TYPE ANY | PID pid | TCB tcb |
| decimal | | Query | TYPE ATX | | |
| jobname | | | TYPE INIT | | |
| Jnnnnn | | | TYPE JOB | | |
| NEXT | | | TYPE OTX | | |
| PREVious | | | TYPE STC | | |
| HOME | | | TYPE SYS | | |
| CURRent | | | TYPE TSU | | |
| FIRSt | | | | | |
| LAST | | | | | |
| SAVE | | | | | |
| RESTORE | | | | | |
+----------------+---------+--------+-------------+-------------------+

Parameters

ASID Parameter Values

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| asid[.dspname] | Sets the target address space or the target |
| | dataspace name within the specified address |
| | space. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| asid | Explanation |
+------------------+--------------------------------------------------+
| hexadecimal | One to eight hexadecimal digits. |
| | Example: ASID 000F |
+------------------+--------------------------------------------------+
| decimal | One to seven decimal digits followed by a decimal|
| | point. |
| | Example: ASID 15. |
+------------------+--------------------------------------------------+
| jobname | The job name. |
| | One to eight characters long, delimited with |
| | character delimiters if it would otherwise be |
| | recognized as hexadecimal data. |
+------------------+--------------------------------------------------+
| Jnnnnn | The JES2 job number. |
| | The nnnnn portion must be one to five decimal |
| | digits. STC and TSU numbers can also be used |
| | but they should still be preceded by a J. |
+------------------+--------------------------------------------------+
| NEXT | The next active ASID from the current ASID. |
+------------------+--------------------------------------------------+
| PREVious | The previous active ASID from the current ASID. |
+------------------+--------------------------------------------------+
| HOME | The original ASID when your session was started. |
+------------------+--------------------------------------------------+
| CURRent | The current ASID. |
+------------------+--------------------------------------------------+
| FIRSt | The first active ASID. |
+------------------+--------------------------------------------------+
| LAST | The last active ASID. |
+------------------+--------------------------------------------------+
| SAVE | Saves the current ASID without switching it. |
+------------------+--------------------------------------------------+
| RESTORE | Switches the ASID value to the value saved by |
| | the last ASID SAVE command. |
+------------------+--------------------------------------------------+

Dataspace Name Parameter Value

+------------------+--------------------------------------------------+
| dspname | Explanation |
+------------------+--------------------------------------------------+
| dspname | A one to eight character target dataspace name. |
| | |
| | If no dspname value is specified, then any |
| | current dataspace name is cleared and the |
| | AR mode set to OFF. |
| | |
| | To specify a dspname with the decimal format |
| | format ASID parameter, you must use two periods. |
| | Example: asid..dspname |
+------------------+--------------------------------------------------+

Option Parameter Values

+------------------+--------------------------------------------------+
| Options | Explanation |
+------------------+--------------------------------------------------+
| SWitch | Requests that the ASID specified by the ASID |
| | parameter is to be switched to. |
| | |
| | This is the default. |
+------------------+--------------------------------------------------+
| Query | Requests that the ASID specified by the ASID |
| | parameter is to be queried. |
| | |
| | The ASID, jobname, job identifier (if any), |
| | and address space type of the specified address |
| | space is displayed in a message. |
| | |
| | No address space switch is performed. |
+------------------+--------------------------------------------------+

TYPE Parameter Value

+------------------+--------------------------------------------------+
| astype | Explanation |
+------------------+--------------------------------------------------+
| TYPE astype | The TYPE astype parameter is optional. |
| | |
| | It is used to restrict the asid parameter to a |
| | specific type of address space. The TYPE astype |
| | parameter is only valid when the asid parameter |
| | is a job name or one of the FIRST, NEXT, |
| | PREVIOUS, or LAST keywords. |
| | |
| | The astype value can be any of the following |
| | keywords: |
| | |
| | ANY - Any address space type. |
| | This is the default. |
| | ATX - An APPC transaction. |
| | INIT - An initiator. |
| | JOB - A batch job. |
| | OTX - An OMVS transaction. |
| | STC - A started task. |
| | SYS - A system task. |
| | TSU - A TSO user. |
| | |
| | If the TYPE astype parameter is specified more |
| | than one time then the last value is used. |
+------------------+--------------------------------------------------+

PID Parameter Value

+------------------+--------------------------------------------------+
| pid | Explanation |
+------------------+--------------------------------------------------+
| PID pid | The PID pid parameter sets the optional |
| | USS process ID value. If set, commands that |
| | accept a PID as a command syntax parameter can |
| | use this value to determine the information |
| | displayed. |
| | |
| | Possible values are: |
| | |
| | * - All PIDs in the current address |
| | space will be displayed. |
| | |
| | xxxxxxxx - Specifies the PID in the current |
| | address space to be displayed. |
| | 1 to 8 hexadecimal digits. |
| | |
| | Example: PID 0304015B |
| | |
| | nnnnnnnnn. - Specifies the PID in the current |
| | address space to be displayed. |
| | 1 to 9 decimal digits. Must end |
| | with a period '.' to indicate |
| | a decimal value. |
| | |
| | Example: PID 123456789. |
+------------------+--------------------------------------------------+

TCB Parameter Value

+------------------+--------------------------------------------------+
| tcb | Explanation |
+------------------+--------------------------------------------------+
| TCB tcb | The TCB tcb parameter sets the optional |
| | TCB value. If set, commands that accept a TCB |
| | as a command syntax parameter can use this |
| | value to determine the information displayed. |
| | |
| | Possible values are: |
| | |
| | * - All TCBs in the current address |
| | space will be displayed. |
| | |
| | xxxxxxxx - Specifies the TCB in the current |
| | address space to be displayed. |
| | 1 to 8 hexadecimal digits. |
| | |
| | Example: TCB 0304015B |
+------------------+--------------------------------------------------+

Notes

The following notes explain how to use certain features of the


ASID command:

* Issuing ASID with no parameters takes you to the HOME address space.

* When used to switch to another address space, the ASID command


refreshes the display if the current command is a memory
switch command.

* To determine the ASID of a jobname or the jobname of an ASID,


use the QUERY option of the ASID command.

Messages

ASID001E [asid] is not a valid ASID

The ASID [asid] is not valid. This can occur when the ASID
specified is greater than the maximum defined ASID. Verify
the maximum defined ASID, and try the command again.

ASID002E ASID [asid] is not active

The requested ASID is not active.

ASID003E ASID with jobname [jobnm] not found

The requested jobname was not found for any active ASID.

ASID004I ASID reset to HOME ASID [asid] job [jobname]


The ASID [asid] specified for job [jobname] equals the HOME ASID.

ASID005I ASID [actn] to ASID [asid] job [jobname]

The ASID has been switched or restored to ASID [asid] and job
[jobname].

ASID006I ASID switched to job [jobname] ASID [asid]

The ASID is successfully switched to ASID [asid] and job [jobname].

ASID007E ASID switch to ASID [asid] job [jobname] failed, ASID inactive

The ASID [asid] specified for the job [jobname] has terminated
before the switch can be completed.

ASID008E ASID switch to ASID [asid] job [jobname] failed, NSS-PC timed out

The switch to ASID [asid] for job [jobname] cannot be completed.


The NSS-PC scheduled to the new ASID has not completed in the
required amount of time. This normally occurs when the requested
ASID is swapped out and MVS cannot or will not swap it back in.

ASID009E Invalid ASID parameter - [asid] parameter

The ASID parameter supplied is not valid.

ASID010I ASID reset to HOME ASID[asid] job [jobname] DSID [dspname]

The ASID has been reset to the original home ASID/job, the data
space name has been set to [dspname], and AR mode has been set
to ON.

ASID011I ASID switched to ASID [asid] job [jobname] DSID [dspname]

The ASID has been switched to ASID [asid] (job [jobname]), the
data space name has been set to [dspname], and AR mode has been
set to ON.

ASID012I ASID [switched] to job [jobname] ASID [asid] DSID [dspname]

The ASID has been switched to job [jobname] (ASID [asid]), the
data space name has been set to [dspname], and AR mode has been
set to ON.

ASID013I ASID [asid] saved

The current target ASID has been saved. It can be restored


with the command "ASID RESTORE".

ASID014E ASID [kwd] invalid with QUERY option

The keyword [kwd] is not valid with the QUERY option.

ASID015I ASID [parm] is ASID [asid] Jobname [jobnm] Jobnr [jobno]

The ASID [parm] corresponds to ASID [asid], job name [jobname],


and job number [jobnr].

ASID016E [kwd] keyword not valid for [cmd] command


The keyword [kwd] is not valid for the [cmd] command.

ASID017W [actn] failed, environment changed while processing command

The [actn] action failed. The environment changed while the


command was processing. Retrying the same command may be
successful.

ASID018E Job number [jobnr] is not type [jobtp]

The requested job number [jobnr] is not the required type


of [jobtp]

ASID019I [parmtyp] [parmval] is ASID [asid] jobname [jobnm] jobid [jobid]


type [type]

Informational only.

ASID021E [cmd] RESTART invalid, ASID [asid] not registered with ARM

Informational only.

ASID022W [cmd] RESTART rejected, ARM not enabled for restarts

Informational only.

ASID023E [cmd] RESTART rejected, ASID [asid] restart threshold reached

Informational only.

ASID024E [cmnd] invalid, ASID [asid] is not cancelable

Informational only.

ASID025E [cmd] invalid, ASID [asid] can't be forced

Informational only.

ASID026E [cmd] rejected, try ASCANCEL first

Informational only.

ASID027E [cmd] invalid, ASID [asid] can't be killed

Informational only.

ASID028I [cmd] issued for ASID [asid] jobname [jobnm] jobid [jobid]

Informational only.

ASID029W Multiple ASIDs with jobname [jobnm] found

The job name specified matched multiple ASIDs. You must use
the explicit hexadecimal ASID for an exact match. Use the
ACTIVITY or ASLIST commands and then use the SELECT command
to display just the jobname you are interested in to see
the associated hex ASID for each job.

ASID030E Invalid hex chars in TCB address - [tcbadd]


Informational only.

ASID031E Address [addr] in ASID [asid] is not a TCB

Informational only.

ASID032E [actn] failed, rs [rsncod]

Informational only.

ASID033I [actn] issued for ASID [asid] jobname [name] jobid [id] TCB [addr]

Informational only.

ASID034I ASID [asid] job [jobnm] jobid [jobid] [type] [kwd] [value]

Informational only.

ASID035E [ascmd] [kwd] failed, [rsn]

Informational only.

ASID036W [cmnd] invalid, ASID [asid] not quiesceable

Informational only.

ASID037W [cmnd] invalid, ASID [asid] already quiesced

Informational only.

ASID038W [cmnd] invalid, ASID [asid] not quiesced

Informational only.

ASID039E [func] not valid for ASID [asid]

Informational only.

ASID040W [func] rejected, status of ASID [asid] has changed

Informational only.

ASID041I Jobname [jobname] DESC [description]

A request was made to query the description of a jobname.


The list of jobnames is found in the JOBNAMES parmlib member.

ASID042E [kwd] keyword valid only for batch job with a job number

The JES keyword of the ASCANCEL command is valid only for


batch jobs that have a job number.

ASID043E Value required for [kwd] keyword

The [kwd] keyword requires a value and none was supplied.

ASID044E Invalid value for [kwd] keyword

The value supplied for the [kwd] keyword is not valid.

ASID045E [kwd] [val] only valid when [asid] parm is a jobname


You can only specify the [kwd] [val] keyword and value
when the [asid] parameter is specified as a jobname.

ASID046W ASID found with jobname [jobnm] but not type [type]

An ASID with the requested job named [jobnm] was found


but its type did not match the type requested with the
TYPE [type] parameter.

ASID047E [kwd] TYPE [astype] not found

An [asid] keyword parameter of [kwd] was specified


along with TYPE [astype] parameter and no matching
ASID was found.

ASID048E ASID with jobname [jobnm] and type [type] not found

An ASID with the job name [jobnm] and type [type] was
not found for any active ASID.

ASID049W Multiple ASIDs with jobname [jobnm] and type [type] found

The job name [jobnm] and type [type] specified matched multiple
ASIDs. You must use the explicit hexadecimal ASID for an exact
match. Use the ACTIVITY or ASLIST commands and then use the
SELECT command to display just the jobname you are interested
in to see the hex ASID associated for each job.

ASID050E The resulting jobname and ASID does not match for [jobname] and [asid]

Information for a jobname and ASID was requested.


The jobname and ASID derived from the specified information
does not result in the same jobname and ASID pair.
ASITYPES

ASITYPES Command

The ASITYPES command shows the rules that are used by SYSVIEW
to assign address space identification types, subtypes and
attributes to an address space.

Command Syntax

+------------------+--------------------------------------------------+
| ASITYPES | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Type,A,SubType,A,RuleType,


Program,A,Pathname,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Type | The address space identification type. |
| | |
| | If blank, the displayed entry is not used |
| | to set the type value. |
+------------------+--------------------------------------------------+
| SubType | The address space identification subtype. |
| | |
| | If blank, the displayed entry is not used |
| | to set the subtype value. |
+------------------+--------------------------------------------------+
| RuleType | The rule type or decision logic used to set |
| | the address space identification type, subtype |
| | or attributes. |
| | |
| | Possible values are: |
| | |
| | EXECPGM - If the program specified on the |
| | "EXEC PGM=program" statement |
| | for the current job step equals |
| | the module specified in the |
| | "program" field, the type, |
| | subtype and attributes will be |
| | set as shown. |
| | |
| | LOADMOD - If a program is loaded that |
| | matches the "LoadMod" field and |
| | the program specified on the |
| | "EXEC PGM=program" statement |
| | for the current job step equals |
| | the module specified in the |
| | "program" field, the type, |
| | subtype and attributes will be |
| | set as shown. |
| | |
| | PATHNAME - If an address space issues a |
| | Unix fetch resulting in the |
| | pathname suffix shown in the |
| | "Pathname" field, the type, |
| | subtype and attributes will be |
| | set as shown. |
+------------------+--------------------------------------------------+
| Program | A program name used by the rule type "EXECPGM" |
| | to match a "EXEC PGM=program" statement for the |
| | current job step. |
+------------------+--------------------------------------------------+
| LoadMod | A program name used by the rule type "LOADMOD" |
| | to override the address space type and subtype |
| | attributes. |
+------------------+--------------------------------------------------+
| Pathname | A UNIX pathname suffix used by the rule type |
| | "PATHNAME". |
+------------------+--------------------------------------------------+
| JVM | An address space identification attribute that |
| | indicates the address space is executing a JVM. |
+------------------+--------------------------------------------------+
| Replace | Indicates that the address space identification |
| | type and subtype are to be replaced if a match |
| | is found using the specified "RuleType". |
| | |
| | Possible values are: |
| | |
| | blank - Do not replace information |
| | |
| | REPLACE - Replace information |
| | |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.
Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the ASLIST command to display address |
| | spaces with matching type and subtype values. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
ASKILL

ASKILL Command

The ASKILL command is used to terminate an address


space that cannot be canceled or forced using the
ASCANCEL or ASFORCE commands. This command is very
dangerous and should only be used as a last resort
when all other attempts to terminate an address space
have failed. The ASKILL command cannot be used to
terminate address spaces that are marked as being not
memtermable even if a dat error occurs. These address
spaces are displayed by the ASLIST command as having
the NOMD attribute.

Indiscriminate use of the ASKILL command can cause


problems that require an IPL to fix. ASKILL, however,
can be used to recover from some situations that would
force an IPL anyway.

Command Syntax

+---------------+-----------------------------------------------------+
| ASKILl | asid [JOBname jobname] [TYPE astype] [opts] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| asid | The ASID parameter identifies the address space |
| | to be killed. The ASID parameter can be |
| | specified using one of the following forms: |
| | |
| | hexasid A hexadecimal ASID specified |
| | as 1 to 4 hexadecimal digits. |
| | |
| | decasid A decimal ASID specified as 1 |
| | to 5 decimal digits followed |
| | by a decimal point. |
| | |
| | jobname A 1 to 8 character jobname. |
| | The jobname must be enclosed |
| | character delimiters if it |
| | would otherwise be recognized |
| | as a hexadecimal ASID. |
| | |
| | jobnumber A 1 to 5 character JES job |
| | number prefixed with a "J". The |
| | job number can be for a batch |
| | job, a TSO user, or a started |
| | task. |
| | |
| | jobid A 1 to 5 character JES job |
| | number prefixed by "JOB", "TSU", |
| | or "STC", for batch jobs, TSO |
| | users, and started tasks, |
| | respectively. The prefix used |
| | must match the prefix of the |
| | actual job. |
| | |
+------------------+--------------------------------------------------+
| JOBname jobname | The JOBNAME parameter must be specified when |
| | the asid parameter is a hexasid or decasid. |
| | |
| | The job name is used to verify and ensure a |
| | match with the job name executing in the |
| | specified asid. |
| | |
| | The JOBNAME parameter will be ignored for |
| | asid parameters other than hexasid or decasid. |
| | |
+------------------+--------------------------------------------------+
| TYPE astype | The TYPE parameter can only be specified |
| | when the asid parameter is a job name. |
| | |
| | It is used to restrict the possible match |
| | to a specific address space type. The astype |
| | value must be one of the following keywords: |
| | |
| | ANY Any address space type. |
| | This is the default. |
| | ATX An APPC transaction. |
| | INIT An initiator. |
| | JOB A batch job. |
| | OTX An OMVS transaction. |
| | STC A started task. |
| | SYS A system task. |
| | TSU A TSO user. |
| | |
+------------------+--------------------------------------------------+
| opts | Optional keyword parameters. Specify any number |
| | in any order from the following list: |
| | |
| | NOConfirm Controls whether you are |
| | Confirm prompted to confirm your |
| | intention. The default is |
| | CONFIRM. |
| | |
| | NOMessage Controls whether a "Command |
| | Message issued" message is generated |
| | at the successful completion |
| | of the command. The default |
| | is MESSAGE. |
| | |
| | The default values for the options listed above |
| | can be changed using the ASOPTION command. The |
| | defaults listed here are the original default |
| | values as the product is distributed. |
| | |
+------------------+--------------------------------------------------+
ASLIST

ASLIST Command

The ASLIST command displays information about every address


space defined in the Address Space Vector Table (ASVT).

Command Syntax

+------------------+--------------------------------------------------+
| ASList | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Type | The address space type. This field is displayed |
| | only when the type can be determined. |
| | Possible values are: |
| | |
| | CICS |
| | DATACOM |
| | IMS |
| | MQ |
| | ROSCOE |
| | |
+------------------+--------------------------------------------------+
| Queue | The address space queue name. |
| | Possible values are: |
| | |
| | MAXUSER Regular user address spaces. |
| | |
| | RSVSTRT Address spaces reserved for started |
| | tasks. |
| | RSVNONR Address spaces reserved for |
| | replacing lost non-reusable address |
| | spaces. |
+------------------+--------------------------------------------------+
| Count | The total ASID count. |
+------------------+--------------------------------------------------+
| Used/Pct% | The count and percentage in use. |
| | |
| | For the MAXUSER and RSVSTRT queues, this is the |
| | number of ASIDs with an ASStatus field value of |
| | ACTIVE. |
| | |
| | For the RSVNONR queue, this is one of the |
| | following: |
| | * The number of RSVNONR ASIDs that have been |
| | used to replace MAXUSER. |
| | * The number of RSVSTRT queue ASIDs that have |
| | been marked as lost. |
+------------------+--------------------------------------------------+
| Free/Pct% | The count and percentage free. |
| | |
| | For the MAXUSER and RSVSTRT queues, this is the |
| | number of ASIDs with an ASStatus field value of |
| | INACTIVE. |
| | |
| | For the RSVNONR queue, this is one of the |
| | following: |
| | * The number of RSVNONR queue entries that |
| | are available to replace MAXUSER. |
| | * The number of RSVSTRT queue entries that |
| | have become lost. |
+------------------+--------------------------------------------------+
| Lost/Pct% | The count and percentage lost and not reusable. |
| | This value should only ever be nonzero for the |
| | MAXUSER and RSVSTRT queues. RSVNONR queue |
| | entries should never be lost. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| ASID | Address space ID. |
+------------------+--------------------------------------------------+
| ASStatus | The address space status. |
| | Possible values are: |
| | |
| | ACTIVE The address space is active. |
| | |
| | INACTIVE The address space is inactive. |
| | |
| | LOSTPERM The address space is permanently |
| | nonreusable. |
| | |
| | LOSTTEMP The address space is temporarily |
| | nonreusable. |
| | |
| | LOSTBOTH The address space is nonreusable. |
| | The ASID was found in the |
| | nonreusable ASID data as both |
| | temporary and permanently |
| | nonreusable. |
| | |
| | LOSTUNKN The address space is nonreusable. |
| | The ASID was not found in the |
| | nonreusable ASID data, so it is |
| | not known whether the condition |
| | is temporary or permanent. |
| | |
| | LOST The address space is nonreusable. |
| | The nonreusable ASID data is not |
| | available so it is unknown whether |
| | the condition is temporary or |
| | permanent. |
| | |
| | USED This value is used only for the NONR|
| | queue type and indicates that the |
| | ASID has been used to replace a lost|
| | USER or STRT queue ASID. |
| | |
| | AVAIL This value is used only for the NONR|
| | queue type and indicates that the |
| | ASID is available to replace a lost |
| | USER or STRT queue ASID. |
| | |
+------------------+--------------------------------------------------+
| Jobname | The job name. When the ASStatus field is |
| | LOSTTEMP or LOSTPERM, this field contains the |
| | name of the job that was active when the |
| | ASID became nonreusable. |
+------------------+--------------------------------------------------+
| Stepname | The current stepname. Stepnames are displayed |
| | only for jobs that have a stepname coded in the |
| | JCL. |
+------------------+--------------------------------------------------+
| Procstep | The current procedure stepname. |
| | Procedure stepnames are displayed only for jobs |
| | that use a PROC statement in the JCL. |
| | For TSO jobs, the terminal name is displayed |
| | in the Procstep field. |
+------------------+--------------------------------------------------+
| Type | The address space type. |
| | Possible values are: |
| | |
| | JOB A batch job |
| | SYS A system task |
| | STC A started task |
| | TSU A TSO user |
| | INIT An initiator |
| | ATX An APPC transaction |
| | OTX An OpenMVS transaction |
| | |
+------------------+--------------------------------------------------+
| Jobnr | The job number. |
| | Some system tasks do not have job numbers. |
+------------------+--------------------------------------------------+
| JobClass | The job input class. |
+------------------+--------------------------------------------------+
| Dispatch | The dispatchability of the address space. |
| | Possible values are: |
| | |
| | RUNNING The address space has one or more |
| | units of work (tasks or SRBs) |
| | running on a processor. |
| | |
| | READYnnn The address space has one or more |
| | units of work (tasks or SRBs) that |
| | are dispatchable but waiting to run |
| | on a processor. The "nnn" portion is |
| | the dispatch priority order up to |
| | a maximum of 255. |
| | |
| | blank The address space is not |
| | dispatchable. |
| | |
+------------------+--------------------------------------------------+
| Status | The address space status. |
| | Possible values are: |
| | |
| | NS Nonswappable |
| | LSW Logically swapped |
| | GO OUT Currently being swapped out |
| | GO IN Currently being swapped in |
| | IN Swapped in |
| | OUT TO Swapped out, terminal output wait |
| | OUT TI Swapped out, terminal input wait |
| | OUT LW Swapped out, long wait |
| | OUT XS Swapped out, auxiliary storage |
| | shortage |
| | OUT RS Swapped out, real storage shortage |
| | OUT DW Swapped out, detected wait |
| | OUT RQ Swapped out, requested swap |
| | OUT NQ Swapped out, enqueue exchange swap |
| | OUT EX Swapped out, exchange on recommended |
| | value |
| | OUT US Swapped out, unilateral swap |
| | OUT TS Swapped out, transition swap |
| | OUT IC Swapped out, improve central storage |
| | OUT IP Swapped out, improve system paging |
| | OUT MR Swapped out, make room |
| | OUT AW Swapped out, APPC wait |
| | OUT OI Swapped out, OMVS input wait |
| | OUT OO Swapped out, OMVS output wait |
| | OUT LS Swapped out, logical swap |
| | OUT LF Swapped out, logical swap fail |
| | OUT SR Swapped out, real swap |
| | |
+------------------+--------------------------------------------------+
| ASIType | Address Space Identification type. |
| | |
| | SYSVIEW will assign address space |
| | identification types, subtypes and attributes |
| | to jobs at job start or the start of each step |
| | within a job. |
| | |
| | SYSVIEW uses a pre-defined set of rules to |
| | determine the type, subtype and attributes |
| | for a job. If unable to assign a specific type, |
| | the address space identification type or |
| | "AsiType" will be set to the program module |
| | specified on the "EXEC PGM=program" JCL |
| | statement. |
| | |
| | The following is a sample list of address |
| | space identification types: |
| | |
| | CICS A CICS region. |
| | |
| | DB2 An IBM Db2 address space. |
| | |
| | DCD A Data Content Discovery |
| | address space. |
| | |
| | IMS An IMS region: BMP, MPP, or JMP. |
| | |
| | JAVA The Java launcher program was |
| | invoked from the Java zFS |
| | directory using a USS batch |
| | utility, exec() or fork() service. |
| | |
| | JZOS The IBM Java Batch Launcher and |
| | Toolkit for z/OS. |
| | |
| | WAS A WebSphere Application Server |
| | address space. |
| | |
| | WAS_LIBERTY A WebSphere Application Server |
| | address space. |
| | |
| | ZCX An IBM z/OS Container Extensions |
| | address space. |
| | |
| | ZOSCONNECT An IBM z/OS Connect EE |
| | address space. |
| | |
| | other The module name from the PGM= |
| | parameter of the JCL EXEC |
| | statement. |
| | |
| | blank The address space started before |
| | SYSVIEW was fully initialized. |
| | If the address space performs any |
| | module load activity, SYSVIEW |
| | will identify the value for the |
| | field. |
| | |
| | A list of address space identification types can |
| | be viewed using the ASITYPES command. |
| | |
| | Additional Address Space Identification |
| | information. |
+------------------+--------------------------------------------------+
| ASISubType | Address Space Identification subtype. |
| | |
| | This field provides additional details for |
| | identifying an address space type. The content |
| | of this field is dependent on the type value |
| | displayed in the ASIType field. |
| | |
| | This field will be blank if there is no |
| | additional identifying information. |
+------------------+--------------------------------------------------+
| Program | The module name from the PGM= parameter of |
| | the EXEC statement. |
+------------------+--------------------------------------------------+
| Parameters | The value specified on the PARM= parameter of |
| | the EXEC statement. |
+------------------+--------------------------------------------------+
| Q | The name of the queue the ASID is on. |
| | Possible values are: |
| | |
| | STRT Queue of ASIDs reserved for started |
| | tasks. |
| | |
| | NONR Queue of ASIDs reserved for |
| | replacing non-reusable address |
| | spaces. |
| | |
| | USER Queue of all other ASIDs. |
| | |
+------------------+--------------------------------------------------+
| SMC | Number of outstanding Step-Must-Complete |
| | requests in the address space. |
+------------------+--------------------------------------------------+
| Xmpt | This field contains XMPT if the ASCB is exempt |
| | from system non-dispatchability; otherwise |
| | it is blank. |
+------------------+--------------------------------------------------+
| PXmt | This field contains PXMT if the ASCB is |
| | permanently exempt from system |
| | non-dispatchability; otherwise it is blank. |
+------------------+--------------------------------------------------+
| NoMT | This field contains NOMT if the ASCB must not |
| | be MEMTERMed unless a DAT error has occurred; |
| | otherwise it is blank. |
+------------------+--------------------------------------------------+
| NoMD | This field contains NOMD if the ASCB must |
| | not be MEMTERMed even if a DAT error has |
| | occurred; otherwise it is blank. |
+------------------+--------------------------------------------------+
| NCan | This field contains NCAN if the ASCB is |
| | noncancelable; otherwise it is blank. |
+------------------+--------------------------------------------------+
| Forc | This field contains FORC if a CANCEL has been |
| | issued for this ASID and a FORCE command can |
| | now be accepted; otherwise it is blank. |
+------------------+--------------------------------------------------+
| 2LPU | This field contains 2LPU if this ASCB is a |
| | second-level preferred user; otherwise it is |
| | blank. |
+------------------+--------------------------------------------------+
| 1LPU | Specifies 1LPU if this ASCB is a first-level |
| | preferred user; otherwise it is blank. |
+------------------+--------------------------------------------------+
| N2LP | This field contains N2LP if SRM SYSEVENT TRANSWAP|
| | should not set the 2LPU attribute; otherwise it |
| | is blank. |
+------------------+--------------------------------------------------+
| XMem | This field contains XMEM if the address space |
| | is a cross-memory address space; otherwise it is |
| | blank. |
+------------------+--------------------------------------------------+
| OMvs | This field contains OMVS if the address space is |
| | an OpenMVS process; otherwise it is blank. |
+------------------+--------------------------------------------------+
| ReUs | This field contains REUS if the address space is |
| | reusable; otherwise it is blank. |
+------------------+--------------------------------------------------+
| RUCSA | This field contains RUCSA if the address space is|
| | authorized for using the Restricted Use Common |
| | Service Area (RUCSA). |
| | |
| | Authorization is granted if the RUCSA is defined |
| | and the job related userid at job start time had |
| | read authority to the SAF facility class |
| | IARRSM.RUCSA. |
+------------------+--------------------------------------------------+
| Aslr24 | This field contains ASLR24 if the address space |
| | is enabled for 24 bit Address Space Layout |
| | Randomization (ASLR). |
| | |
| | The ASLR feature is enabled using the following |
| | DIAGxx parameter option: |
| | |
| | ASLR(parm) |
| | |
| | XMVS D DIAG |
| | |
| | Jobs with read access to the SAF facility class |
| | entity IARRSM.EXEMPT.ASLR.[jobname] will not |
| | be subject to ASLR. |
| | |
| | Jobs with read access to the SAF facility class |
| | entity IARRSM.EXEMPT.ASLR24.[jobname] will not |
| | be subject to 24 bit ASLR. |
| | |
+------------------+--------------------------------------------------+
| Aslr31 | This field contains ASLR31 if the address space |
| | is enabled for 31 bit Address Space Layout |
| | Randomization (ASLR). |
| | |
| | The ASLR feature is enabled using the following |
| | DIAGxx parameter option: |
| | |
| | ASLR(parm) |
| | |
| | XMVS D DIAG |
| | |
| | Jobs with read access to the SAF facility class |
| | entity IARRSM.EXEMPT.ASLR.[jobname] will not |
| | be subject to ASLR. |
| | |
+------------------+--------------------------------------------------+
| Aslr64 | This field contains ASLR64 if the address space |
| | is enabled for 64 bit Address Space Layout |
| | Randomization (ASLR). |
| | |
| | The ASLR feature is enabled using the following |
| | DIAGxx parameter option: |
| | |
| | ASLR(parm) |
| | |
| | XMVS D DIAG |
| | |
| | Jobs with read access to the SAF facility class |
| | entity IARRSM.EXEMPT.ASLR.[jobname] will not |
| | be subject to ASLR. |
| | |
+------------------+--------------------------------------------------+
| JobReq | Indicates if the job has been defined as a job |
| | that is required to be active. |
| | |
| | Possible values are: |
| | blank - job is not required to be active |
| | JOBREQ - job is required to be active |
| | |
| | Required jobs can be defined via the MONRULES |
| | command. |
| | |
| | Metric Exclude RsceScope |
| | MVS_JOB_Status INCLUDE jobname |
| | |
+------------------+--------------------------------------------------+
| Description | A description of the address space based on the |
| | jobname, as defined in the JOBNAMES parmlib |
| | member. |
+------------------+--------------------------------------------------+
| SToken | The address space token. |
+------------------+--------------------------------------------------+
| Instance | The address space instance number. |
+------------------+--------------------------------------------------+
| ASCB | The ASCB address. |
+------------------+--------------------------------------------------+
| ASSB | The ASSB address. |
+------------------+--------------------------------------------------+
| ASTE | The ASTE address. |
+------------------+--------------------------------------------------+
| CSCB | The CSCB address. |
+------------------+--------------------------------------------------+
| OUCB | The OUCB address. |
+------------------+--------------------------------------------------+
| OUXB | The OUXB address. |
+------------------+--------------------------------------------------+
| ASXB | The ASXB address. |
+------------------+--------------------------------------------------+
| XMSE | Displays the XMSE address if the ASID status is |
| | LOSTTEMP or LOSTPERM. The XMSE is a control |
| | block that resides in the private area of the |
| | PCAUTH address space (ASID=2). |
+------------------+--------------------------------------------------+
| SETC | Displays the SETC address if the ASID status is |
| | LOSTTEMP or LOSTPERM. The SETC is a control |
| | block that resides in the private area of the |
| | PCAUTH address space (ASID=2). |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| CANcel [Dump] | Invokes the MVS CANCEL command to cancel an |
| [Restart] | address space. For more information on the |
| | MVS CANCEL command, see the IBM Systems Command |
| | manual. The CANCEL line command is rejected if |
| | the address space has the NCAN attribute. If |
| | the value of the SET CONFIRMDELET option is YES, |
| | you are prompted to confirm your intention to |
| | cancel the selected address space. You can |
| | specify the RESTART keyword to restart the |
| | address space using the services of the |
| | MVS Automatic Restart Manager (ARM). |
+------------------+--------------------------------------------------+
| FORce | Invokes the MVS FORCE command to force an |
| [Restart] | address space. For more information on the |
| | MVS FORCE command, see the IBM System Commands |
| | manual. The FORCE line command is rejected under |
| | the following conditions: |
| | |
| | * The address space has the NOMT attribute. |
| | * The address space does not have the NCAN |
| | attribute and the FORC attribute. |
| | In this case, try using the CANCEL line |
| | command first. |
| | An MVS FORCE xxx,ARM command is issued if |
| | the address space does not have the FORC |
| | attribute. Otherwise a straight MVS FORCE |
| | command is issued. If the value of the |
| | SET CONFIRMDELET option is YES, you are |
| | prompted to confirm your intention to force |
| | the selected address space. |
| | |
| | Indiscriminate use of the FORCE command may |
| | cause problems that require an IPL to fix. |
| | Before using this command, make sure you |
| | understand all of the implications and |
| | warnings listed for the MVS FORCE command |
| | in the IBM System Commands manual. |
| | |
| | You can specify the RESTART keyword to restart |
| | the address space using the services of the |
| | MVS Automatic Restart Manager (ARM). |
+------------------+--------------------------------------------------+
| KILl | Terminates an address space that could not be |
| | canceled or forced using the CANCEL or FORCE |
| | commands described above. The KILL line |
| | command is rejected if the address space has |
| | the NOMD attribute. This command is even more |
| | dangerous than the FORCE command. Use it only |
| | as a last resort when all else has failed. |
| | If the value of the SET CONFIRMDELET option |
| | is YES, you are prompted to confirm your |
| | intention to kill the selected address space. |
+------------------+--------------------------------------------------+
| NOSwap | Makes the address space nonswappable. |
+------------------+--------------------------------------------------+
| OKSwap | Makes the address space swappable. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| CPu | Plots the CPU usage for the selected job. |
+------------------+--------------------------------------------------+
| IOrate | Plots the I/O rate for the selected job. |
+------------------+--------------------------------------------------+
| Menu | Invokes a MENU ADDRSPC command. |
+------------------+--------------------------------------------------+
| MStg | Plots real storage utilization for the selected |
| | job.
+------------------+--------------------------------------------------+
| PGrate | Plots the paging rate for the selected job. |
+------------------+--------------------------------------------------+
| PLot | Invokes a PLOTLIST ASID command to display a plot|
| | selection list for the selected job. |
+------------------+--------------------------------------------------+
| Select | Invokes the ASID command for the selected ASID |
| | to set it as the target address space. |
| | |
| | Note: For inactive address spaces, |
| | SELECT is invalid. |
+------------------+--------------------------------------------------+
| Any valid | You can issue a valid primary command as an |
| primary | ASLIST line command. If the specified command |
| command | is as memory sensitive command (such as DUMP |
| | or JPA), an ASID command sensitive command |
| | (such as DUMP or JPA), an ASID command is |
| | internally generated to switch to the selected |
| | address space before invoking the requested |
| | command. If the specified command supports a |
| | jobname and jobnumber parameter as the first |
| | two parameters (such as OUTPUT and STEPSUM) and |
| | no other parameters were entered in the line |
| | command input area, the requested command is |
| | invoked with the jobname and number from the |
| | selected address space. All other commands are |
| | invoked just as if they had been entered |
| | in the primary command input area. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+

Messages

ASLI001E Parameters not allowed on [cmdname] line command

Informational only.

ASLI002E Invalid [cmdname] line command parameters [errparms]

Informational only.

ASLI003E [cmdname] not valid for ASID [asid]

Informational only.

ASLI004E [cmdname] invalid, ASID [asid] has [attr] attribute

Informational only.

ASLI005W [cmdname] rejected, status of ASID [asid] has changed


Informational only.

ASLI006W [cmdname] rejected, try [altname] first

Informational only.

ASLI007E [cmdname] invalid, ASID [asid] not registered with ARM

Informational only.

ASLI008W [cmdname] rejected, ARM not enabled for restarts

Informational only.

ASLI009E [cmdname] rejected, ASID [asid] restart threshold reached

Informational only.
ASLOCKS

ASLOCKS Command

The ASLOCKS command displays system-wide and address space


specific suspend lock instrumentation data collected by the
operating system and stored in LOCKI control blocks mapped
by the DSECTs generated by the IHALOCKI macro.

Command Syntax

+------------------+--------------------------------------------------+
| ASLOCKS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| ASID | The address space identifier. This field will |
| | be blank for the "*SYSTEM*" job name. |
+------------------+--------------------------------------------------+
| Jobname | The job name. |
+------------------+--------------------------------------------------+
| Type | The address space type. Values can be |
| | |
| | JOB A batch job |
| | SYS A system task |
| | STC A started task |
| | TSU A TSO user |
| | INI An initiator |
| | ATX An APPC transaction |
| | OTX An OpenMVS transaction |
| | |
| | This field will be blank for the "*SYSTEM*" |
| | job name. |
+------------------+--------------------------------------------------+
| Jobnr | The job number. This field will be blank for |
| | an address space not started by JES and for |
| | the "*SYSTEM*" job name. |
+------------------+--------------------------------------------------+
| Status | The address space status. Values can be |
| | |
| | NS Nonswappable |
| | LSW Logically swapped |
| | GO OUT Currently being swapped out |
| | GO IN Currently being swapped in |
| | IN Swapped in |
| | OUT TO Swapped out, terminal output wait |
| | OUT TI Swapped out, terminal input wait |
| | OUT LW Swapped out, long wait |
| | OUT XS Swapped out, auxiliary storage |
| | shortage |
| | OUT RS Swapped out, real storage shortage |
| | OUT DW Swapped out, detected wait |
| | OUT RQ Swapped out, requested swap |
| | OUT NQ Swapped out, enqueue exchange swap |
| | OUT EX Swapped out, exchange on |
| | recommended value |
| | OUT US Swapped out, unilateral swap |
| | OUT TS Swapped out, transition swap |
| | OUT IC Swapped out, improve central |
| | storage |
| | OUT IP Swapped out, improve system paging |
| | OUT MR Swapped out--make room |
| | |
| | This field will be blank for the "*SYSTEM*" |
| | job name. |
+------------------+--------------------------------------------------+
| LockName | The lock name. Values can be |
| | |
| | CMSSMF SMF cross memory services (CMS) |
| | lock. The SMFCMS lock serializes |
| | SMF functions and control blocks. |
| | |
| | CMSENQDEQ ENQ/DEQ CMS lock. The ENQDEQCMS |
| | lock serializes ENQ/DEQ functions |
| | and control blocks. |
| | |
| | CMSLATCH Latch CMS lock. The LATCHCMS |
| | lock serializes latch functions |
| | and control blocks. |
| | |
| | CMS General cross memory services |
| | lock. The CMS lock serializes |
| | on more than address space |
| | when this serialization is not |
| | provided by one or more of the |
| | other global locks. The CMS lock |
| | provides global serialization |
| | when enablement is required. |
| | |
| | LOCAL Local storage lock. The LOCAL |
| | lock serializes functions and |
| | storage within a local address |
| | space. One LOCAL lock exists |
| | per address space. |
| | |
| | CML_OWN Local cross memory storage lock. |
| | CML_REQ The CML lock serializes functions |
| | and storage within an address |
| | space other than the home address |
| | space. One CML lock exists per |
| | address space. The CML_OWN lock |
| | data is for the address space that|
| | owns the CML lock. The CML_REQ |
| | lock data is for the address |
| | space that requested the CML |
| | lock. |
| | |
+------------------+--------------------------------------------------+
| Susp | The number of times a unit of work was suspended |
| | on the lock. |
+------------------+--------------------------------------------------+
| ASusp | The number of times a unit of work was suspended |
| | on the lock when there was already at least one |
| | other unit of work suspended. |
+------------------+--------------------------------------------------+
| SuspTime | The total amount of time any and all units of |
| | work were suspended waiting for the lock. |
+------------------+--------------------------------------------------+
| AvgTime | The average amount of time all work units were |
| | suspended waiting for the lock. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| S | Invokes the OUTPUT command to display any job output. |
| | This line command is not valid when the "Jobnr" field |
| | is blank. |
+----------+----------------------------------------------------------+
| L | Invokes the LISTFILE command to list the output files |
| | for the job. This line command is not valid when the |
| | "Jobnr" field is blank. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
ASLOST

ASLOST Command

The ASLOST command displays information about nonreusable


address spaces.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| ASLOst | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| ASID | The ASID of the nonreusable address space. |
+------------------+--------------------------------------------------+
| Jobname | The name of the job that was active when the |
| | ASID became nonreusable. |
+------------------+--------------------------------------------------+
| SToken | The address space token. |
+------------------+--------------------------------------------------+
| Type | The nonreusability type. Values can be |
| | |
| | PERM The address space is permanently |
| | nonreusable because it had an entry |
| | table connected to a system LX. |
| | |
| | TEMP The address space is temporarily |
| | nonreusable. One or more active |
| | address spaces still have connections |
| | to this address space. These address |
| | spaces are identified by the CAID, |
| | CJobName, and CSToken fields that |
| | follow. When all of these connecting |
| | address spaces have ended, this |
| | address space will become reusable. |
| | |
+------------------+--------------------------------------------------+
| Q | The queue the lost ASID is on. Values can be |
| | |
| | STRT Queue of ASIDs reserved for started |
| | tasks. |
| | |
| | NONR Queue of ASIDs reserved for replacing |
| | non-reusable address spaces. This |
| | value should not occur. |
| | |
| | USER Queue of all other ASIDs. |
| | |
+------------------+--------------------------------------------------+
| CASID | The ASID of an active address space that is |
| | still connected to a temporarily nonreusable |
| | address space. |
+------------------+--------------------------------------------------+
| CJobname | The job name of an active address space that is |
| | still connected to a temporarily nonreusable |
| | address space. |
+------------------+--------------------------------------------------+
| CSToken | The address space token of an active address |
| | space that is still connected to a temporarily |
| | nonreusable address space. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
ASNOSWAP

ASNOSWAP Command

The ASNOSWAP command is used to make an address


space nonswappable.

Command Syntax

+---------------+-----------------------------------------------------+
| ASNOSwap | asid [JOBname jobname] [TYPE astype] [opts] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| asid | The ASID parameter identifies the address space |
| | to be made nonswappable. The ASID parameter can |
| | be specified using one of the following forms: |
| | |
| | hexasid A hexadecimal ASID specified as |
| | 1 to 4 hexadecimal digits. |
| | |
| | decasid A decimal ASID specified as 1 to |
| | 5 decimal digits followed by a |
| | decimal point. |
| | |
| | jobname A 1 to 8 character jobname. The |
| | jobname must be enclosed |
| | character delimiters if it would |
| | otherwise be recognized as a |
| | hexadecimal ASID. |
| | |
| | jobnumber A 1 to 5 character JES job |
| | number prefixed with a "J". The |
| | job number can be for a batch |
| | job, a TSO user, or a started |
| | task. |
| | |
| | jobid A 1 to 5 character JES job |
| | number prefixed by "JOB", "TSU", |
| | or "STC, for batch jobs, TSO |
| | users, and started tasks, |
| | respectively. The prefix used |
| | must match the prefix of the |
| | actual job. |
| | |
+------------------+--------------------------------------------------+
| JOBname jobname | The JOBNAME parameter must be specified when |
| | the asid parameter is a hexasid or decasid. |
| | |
| | The job name is used to verify and ensure a |
| | match with the job name executing in the |
| | specified asid. |
| | |
| | The JOBNAME parameter will be ignored for |
| | asid parameters other than hexasid or decasid. |
| | |
+------------------+--------------------------------------------------+
| TYPE astype | The TYPE parameter can only be specified |
| | when the asid parameter is a job name. |
| | |
| | It is used to restrict the possible match |
| | to a specific address space type. The astype |
| | value must be one of the following keywords: |
| | |
| | ANY Any address space type. |
| | This is the default. |
| | ATX An APPC transaction. |
| | INIT An initiator. |
| | JOB A batch job. |
| | OTX An OMVS transaction. |
| | STC A started task. |
| | SYS A system task. |
| | TSU A TSO user. |
| | |
+------------------+--------------------------------------------------+
| opts | Optional keyword parameters. Specify any number |
| | in any order from the following list: |
| | |
| | NOConfirm Controls whether you are |
| | Confirm prompted to confirm your |
| | intention. The default is |
| | CONFIRM. |
| | |
| | NOMessage Controls whether a "Command |
| | Message issued" message is generated at |
| | the successful completion of |
| | the command. The default is |
| | MESSAGE. |
| | |
| | The default values for the options listed above |
| | can be changed using the ASOPTION command. The |
| | defaults listed here are the original default |
| | values as the product is distributed. |
| | |
+------------------+--------------------------------------------------+
ASOKSWAP

ASOKSWAP Command

The ASOKSWAP command is used to make an address space swappable.


Making an address space swappable when it is designed
to execute nonswappable may cause it to fail.

Command Syntax

+---------------+-----------------------------------------------------+
| ASOKSwap | asid [JOBname jobname] [TYPE astype] [opts] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| asid | The ASID parameter identifies the address space |
| | to be made swappable. The ASID parameter can be |
| | specified using one of the following forms: |
| | |
| | hexasid A hexadecimal ASID specified as |
| | 1 to 4 hexadecimal digits. |
| | |
| | decasid A decimal ASID specified as 1 to |
| | 5 decimal digits followed by a |
| | decimal point. |
| | |
| | jobname A 1 to 8 character jobname. The |
| | jobname must be enclosed |
| | character delimiters if it |
| | would otherwise be recognized as |
| | a hexadecimal ASID. |
| | |
| | jobnumber A 1 to 5 character JES job |
| | number prefixed with a "J". The |
| | job number can be for a batch |
| | job, a TSO user, or a started |
| | task. |
| | |
| | jobid A 1 to 5 character JES job |
| | number prefixed by "JOB", "TSU", |
| | or "STC, for batch jobs, TSO |
| | users, and started tasks, |
| | respectively. The prefix used |
| | must match the prefix of the |
| | actual job. |
| | |
+------------------+--------------------------------------------------+
| JOBname jobname | The JOBNAME parameter must be specified when |
| | the asid parameter is a hexasid or decasid. |
| | |
| | The job name is used to verify and ensure a |
| | match with the job name executing in the |
| | specified asid. |
| | |
| | The JOBNAME parameter will be ignored for |
| | asid parameters other than hexasid or decasid. |
| | |
+------------------+--------------------------------------------------+
| TYPE astype | The TYPE parameter can only be specified |
| | when the asid parameter is a job name. |
| | |
| | It is used to restrict the possible match |
| | to a specific address space type. The astype |
| | value must be one of the following keywords: |
| | |
| | ANY Any address space type. |
| | This is the default. |
| | ATX An APPC transaction. |
| | INIT An initiator. |
| | JOB A batch job. |
| | OTX An OMVS transaction. |
| | STC A started task. |
| | SYS A system task. |
| | TSU A TSO user. |
| | |
+------------------+--------------------------------------------------+
| opts | Optional keyword parameters. Specify any number |
| | in any order from the following list: |
| | |
| | NOConfirm Controls whether you are |
| | Confirm prompted to confirm your |
| | intention. The default is |
| | CONFIRM. |
| | |
| | NOMessage Controls whether a "Command |
| | Message issued" message is generated at |
| | the successful completion of |
| | the command. The default is |
| | MESSAGE. |
| | |
| | The default values for the options listed above |
| | may be changed using the ASOPTION command. The |
| | defaults listed here are the original default |
| | values as the product is distributed. |
| | |
+------------------+--------------------------------------------------+
ASOPTION

ASOPTION Command

The ASOPTION command is used to set and display the


default option values used by the following commands:

ASCANCEL Cancel an address space


ASFORCE Force an address space
ASKILL Kill an address space
ASNOSWAP Make an address space nonswappable
ASOKSWAP Make an address space swappable
ASQUIESC Quiesce an address space
ASRESUME Resume a quiesced address space
ASEXTRAC Extract address space identification
ASCANTSK Cancel a task within an address space

Command Syntax

+---------------+-----------------------------------------------------+
| ASOPTion | [opts] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| opts | Optional keyword parameters. Specify any |
| | number in any order from the following list: |
| | |
| | NODump Controls whether a dump is |
| | Dump requested. This applies only |
| | to the ASCANCEL command. The |
| | default is NODUMP. |
| | |
| | NORestart Controls whether a job restart |
| | Restart is requested through the |
| | services of the MVS Automatic |
| | Restart Manager. This applies |
| | to the ASCANCEL and ASFORCE |
| | commands. The default is |
| | NORESTART. |
| | |
| | NOConfirm Controls whether you are |
| | Confirm prompted to confirm your |
| | intention. This applies to the |
| | ASCANCEL, ASFORCE, ASKILL, |
| | ASNOSWAP, ASOKSWAP, ASQUIESC, |
| | and ASRESUME commands. The |
| | default is CONFIRM. |
| | |
| | NOMessage Controls whether a "Command |
| | Message issued" message is generated at |
| | the successful completion of |
| | the command. This applies to |
| | the ASCANCEL, ASFORCE, ASKILL, |
| | ASNOSWAP, ASOKSWAP, ASQUIESC, |
| | ASRESUME and ASEXTRACT commands.|
| | The default is MESSAGE. |
| | |
| | EXTRact Requests that the current option |
| | settings be extracted into a |
| | TSO CLIST or REXX EXEC variable. |
| | The variable created or updated |
| | is named |
| | |
| | SYSV_OPTIONS_ASOPTION |
| | |
| | This keyword is only valid when |
| | the product is running under a |
| | TSO CLIST or REXX EXEC. The |
| | EXTRACT keyword can be |
| | specified alone or in |
| | combination with any other |
| | ASOPTION keywords. |
| | |
| | The default values listed above are the original |
| | defaults values as the product is distributed. |
+------------------+--------------------------------------------------+
ASPERF

ASPERF Command

The ASPERF command displays performance information


for active address spaces. Address space related
metrics can be easily extracted from this display
via the SYSVIEW API.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| ASPERF | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ JOBName jobname ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYSTEM | This forces cross system data collection to be |
| XSDATA | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYSTEM | This forces cross system data collection to be |
| NOXSDATA | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| jobname | Limit the display to only those entries with a |
| | corresponding value in the Jobname field. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| CP | The normalization factor for the processor type |
| | CP. |
+------------------+--------------------------------------------------+
| IFA | The normalization factor for the processor type |
| | IFA. Multiply the processor time by the factor |
| | and divide by 256 to obtain the equivalent |
| | time on a CP processor. |
+------------------+--------------------------------------------------+
| IIP | The normalization factor for the processor type |
| | IIP. Multiply the processor time by the factor |
| | and divide by 256 to obtain the equivalent |
| | time on a CP processor. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| ASID | The hexadecimal address space ID. |
+------------------+--------------------------------------------------+
| Jobname | The name of the job. |
+------------------+--------------------------------------------------+
| JobStat | The status of the job. Valid values are: |
| | |
| | NS Nonswappable |
| | LSW Logically swapped |
| | GO OUT Currently being swapped out |
| | GO IN Currently being swapped in |
| | IN Swapped in |
| | OUT TO Swapped out--terminal output wait |
| | OUT TI Swapped out--terminal input wait |
| | OUT LW Swapped out--long wait |
| | OUT XS Swapped out--auxiliary storage |
| | shortage |
| | OUT RS Swapped out--real storage shortage |
| | OUT DW Swapped out--detected wait |
| | OUT RQ Swapped out--requested swap |
| | OUT NQ Swapped out--enqueue exchange swap |
| | OUT EX Swapped out--exchange on recommended |
| | value |
| | OUT US Swapped out--unilateral swap |
| | OUT TS Swapped out--transition swap |
| | OUT IC Swapped out--improve central storage |
| | OUT IP Swapped out--improve system paging |
| | OUT MR Swapped out--make room |
| | OUT AW Swapped out--APPC wait |
| | OUT OI Swapped out--input wait |
| | OUT OO Swapped out--output wait |
| | OUT LS Swapped out--logical swap |
| | OUT LF Swapped out--logical swap fail |
| | OUT SR Swapped out--real swap |
| | blank No address space found with the |
| | specified jobname |
+------------------+--------------------------------------------------+
| Type | The type of job. Valid values are: |
| | |
| | JOB A batch job |
| | SYS A system task |
| | STC A started task |
| | TSU A TSO user |
| | INI An initiator |
| | ATX An APPC transaction |
| | OTX An OpenMVS transaction |
+------------------+--------------------------------------------------+
| Jobnr | The job number. |
+------------------+--------------------------------------------------+
| Stepname | The current stepname. Stepnames are displayed |
| | only for jobs that have a stepname coded in the |
| | JCL. |
+------------------+--------------------------------------------------+
| Procstep | The current procedure stepname. Procedure |
| | stepnames are displayed only for jobs that use a |
| | PROC statement in the JCL. |
+------------------+--------------------------------------------------+
| JobClass | The job input class. Only batch jobs have a job |
| | input class. |
+------------------+--------------------------------------------------+
| Clocktime | The amount of wall clock time the job has been |
| | executing. |
| | |
| | Source: ASCB.ASCBINTS |
| | |
| | Metric: MVS_JOB_ClockTime |
+------------------+--------------------------------------------------+
| CPUTime | The accumulated CPU time (in CPU seconds) used |
| | by the job. |
| | |
| | Source: ASCB.ASCBEJST |
| | + ASCB.ASCBSRBT |
| | + ASSB.ASSBPHTM |
| | |
| | Metric: MVS_JOB_CpuTime |
| | MVS_JOB_CpuTimeTotal |
+------------------+--------------------------------------------------+
| CPTime | The accumulated task CPU time. |
| | |
| | Source: ASSB.ASSB_TASK_TIME_ON_CP |
| | + ASSB.ASSB_SRB_TIME_ON_CP |
| | + ASSB.ASSBPHTM |
| | - ASSB.ASSB_zIIP_PHTM |
| | - ASSB.ASSB_IFA_PHTM |
| | |
| | Metric: MVS_JOB_CpCpuTime |
| | MVS_JOB_CpCpuTimeTotal |
+------------------+--------------------------------------------------+
| CP% | The percent of the total address space CPU time |
| | that has been executed on a CP processor. |
| | |
| | CP% = CPTime * 100 |
| | ---------------------- |
| | CpuTime |
| | |
| | Metric: MVS_JOB_Cp% |
| | MVS_JOB_CpTotal% |
+------------------+--------------------------------------------------+
| IIPTime | IIP time |
| | |
| | Source: (ASSB.ASSB_TIME_ON_zIIP * factor)/256 |
| | + ASSB_zIIP_ENCT |
| | |
| | Metric: MVS_JOB_IipCpuTime |
| | MVS_JOB_IipCpuTimeTotal |
+------------------+--------------------------------------------------+
| IIP% | The percent of the total address space CPU time |
| | that has been executed on a IIP processor. |
| | |
| | IIP% = IIPTime * 100 |
| | ---------------------- |
| | CpuTime |
| | |
| | Metric: MVS_JOB_Iip% |
| | MVS_JOB_IipTotal% |
+------------------+--------------------------------------------------+
| IFATime | IFA time |
| | |
| | Source: (ASSB.ASSB_TIME_ON_IFA * factor)/256 |
| | + ASSB_IFA_ENCT |
| | |
| | Metric: MVS_JOB_IfaCpuTime |
| | MVS_JOB_IfaCpuTimeTotal |
+------------------+--------------------------------------------------+
| IFA% | The percent of the total address space CPU time |
| | that has been executed on a IFA processor. |
| | |
| | IFA% = IFATime * 100 |
| | ---------------------- |
| | CpuTime |
| | |
| | Metric: MVS_JOB_Ifa% |
| | MVS_JOB_IfaTotal%
+------------------+--------------------------------------------------+
| EnclTime | The accumulated enclave CPU time. |
| | |
| | Source: ASSB.ASSB_ENCT |
| | + ASSB_zIIP_ENCT |
| | + ASSB_IFA_ENCT |
| | |
| | Metric: MVS_JOB_EnclaveTime |
| | MVS_JOB_EnclaveTimeTotal |
+------------------+--------------------------------------------------+
| ePct% | The percent of the total CPU time used by the |
| | task that executed on an enclave. |
| | |
| | ePct% = EnclTime * 100 |
| | --------------------- |
| | CpuTime |
| | |
| | Metric: MVS_JOB_Enclave% |
| | MVS_JOB_EnclaveTotal% |
+------------------+--------------------------------------------------+
| RealStg | The amount of real storage the job is using in |
| | the private region. |
| | |
| | Source: RAX.RAXFMCT * 4096 |
| | |
| | Metric: MVS_JOB_RealStorage |
+------------------+--------------------------------------------------+
| FreeStg | The amount of real storage owned by the address |
| | space that has been freed and is not currently |
| | in use by the address space. |
| | |
| | Source: RAX.RAX_FreemainedFrames * 4096 |
+------------------+--------------------------------------------------+
| AuxStg | The amount of auxiliary storage the job is |
| | using. |
| | |
| | Source: (RAX.ASSBVSC + ASSB.ASSBNVSC) * 4096 |
| | |
| | Metric: MVS_JOB_AuxStorage |
+------------------+--------------------------------------------------+
| WorkSet | The working set size. |
| | |
| | Source: (RAX.RAXFMCT |
| | + RAX.RAXESCT |
| | + ASSB.ASSBVSC |
| | + ASSB.ASSBNVSC |
| | ) * 4096 |
| | |
| | Metric: MVS_JOB_WorkingSetSize |
+------------------+--------------------------------------------------+
| SCMStg | The amount of Storage Class Memory (SCM) in use. |
| | |
| | Source: ASSB.ASSB_SCMBC * 4096 |
| | |
| | Metric: MVS.JOBSCM |
+------------------+--------------------------------------------------+
| GRealStg | The amount of real storage to back 64-bit |
| | private storage. |
| | |
| | Source: RAX.RAXHVPagesInReal * 4096 |
| | |
| | Metric: MVS_JOB_StorageClassMemory |
+------------------+--------------------------------------------------+
| GAuxStg | The amount of auxiliary storage used to |
| | back 64-bit private storage. |
| | |
| | Source: RAX.RAXHVAuxSlots * 4096 |
| | |
| | Metric: MVS_JOB_AuxBackingGpvt |
+------------------+--------------------------------------------------+
| IOCount | The number of I/O operations performed by the |
| | job. |
| | |
| | Source: ASCB.ASCBIOSX |
| | |
| | Metric: MVS_JOB_IoRate |
| | MVS_JOB_Ios |
+------------------+--------------------------------------------------+
| ASCBEJST | Jobstep CPU time |
| | |
| | Source: ASCB.ASCBEJST |
| | |
| | Metric: MVS_JOB_TcbTime |
| | MVS_JOB_TcbTimeTotal |
+------------------+--------------------------------------------------+
| ASCBSRBT | Accumulated SRB time |
| | |
| | Source: ASCB.ASCBSRBT |
| | |
| | Metric: MVS_JOB_SrbTime |
| | MVS_JOB_SrbTimeTotal |
+------------------+--------------------------------------------------+
| ASCBEATT | Expended and accounted task time |
| | |
| | Source: ASCB.ASCBEATT |
+------------------+--------------------------------------------------+
| TaskOnCP | Time on CP in task mode for the address space. |
| | |
| | Valid only when zAAP or SUP processors are |
| | installed. |
| | |
| | Source: ASSB.ASSB_TASK_TIME_ON_CP |
| | |
| | Metric: MVS_JOB_TimeOnCp |
| | MVS_JOB_TimeOnCpTotal |
+------------------+--------------------------------------------------+
| SRBonCP | Time on CP in SRB mode for the address space. |
| | |
| | Valid only when zAAP or SUP processors are |
| | installed. |
| | |
| | Source: ASSB.ASSB_SRB_TIME_ON_CP |
+------------------+--------------------------------------------------+
| ASSTonCP | Additional SRB Service Time on a standard CP. |
| | CPU time is accumulated for the address space's |
| | Preemptable SRBs and for Client Related SRBs |
| | for which the address space is the client. |
| | |
| | Valid only when zAAP or SUP processors are |
| | installed. |
| | |
| | Source: ASSB.ASSB_ASST_TIME_ON_CP |
+------------------+--------------------------------------------------+
| ASSBPHTM | Preemptable-class SRB time. The CPU time for |
| | all types of preemptable SRBs (PSRB, CRSRB, ESRB)|
| | executing with this address space as the home |
| | space is accumulated here. This value is not |
| | used in SMF or SRM calculations. |
| | |
| | Source: ASSB.ASSBPHTM |
| | |
| | Metric: MVS_JOB_PreemptableSrbTime |
| | MVS_JOB_PreemptableSrbTimeTotal |
+------------------+--------------------------------------------------+
| zIIPPHTM | zIIP only equivalent of the ASSBPHTM value. |
| | |
| | Source: ASSB.ASSB_zIIP_PHTM |
+------------------+--------------------------------------------------+
| IFAPHTM | IFA only equivalent of ASSBPHTM |
| | |
| | Source: ASSB.ASSB_IFA_PHTM |
+------------------+--------------------------------------------------+
| TimezIIP | zIIP time. Enclave time is not included. |
| | |
| | Source: ASSB.ASSB_TIME_ON_zIIP |
| | |
| | This value is NOT normalized. |
| | |
| | Metric: MVS_JOB_IipNonEnclave |
| | MVS_JOB_IipNonEnclaveTotal |
+------------------+--------------------------------------------------+
| zIIPonCP | zIIP time on CP. Enclave time is not included. |
| | |
| | When zAAPzIIP=YES is in effect, zAAP |
| | eligible work running on a CP is included. |
| | |
| | Source: ASSB.ASSB_TIME_zIIP_ON_CP |
| | |
| | Metric: MVS_JOB_IipEligibleOnCp |
| | MVS_JOB_IipEligibleOnCpTotal |
+------------------+--------------------------------------------------+
| zIIPENCT | Enclave zIIP time in the address space. |
| | |
| | Source: ASSB.ASSB_zIIP_ENCT |
| | |
| | Metric: MVS_JOB_EnclaveIfaTime |
| | MVS_JOB_EnclaveIfaTimeTotal |
+------------------+--------------------------------------------------+
| SUPCPENC | Enclave time for SUP on CP in the address space. |
| | |
| | Source: ASSB.ASSB_SUP_ON_CP_ENCT |
| | |
| | Metric: MVS_JOB_EnclaveIipTimeOnCp |
+------------------+--------------------------------------------------+
| ASSBASST | Additional SRB Service Time. CPU time is |
| | accumulated for the address space's |
| | Preemptable SRBs and for Client Related SRBs |
| | for which the address space is the client. |
| | |
| | Source: ASSB.ASSBASST |
| | |
| | Metric: MVS_JOB_AdditionalSrbTime |
| | MVS_JOB_AdditionalSrbTimeTotal |
+------------------+--------------------------------------------------+
| ASSBENCT | Enclave time in the address space on a |
| | standard CP. |
| | |
| | Source: ASSB.ASSB_ENCT |
| | |
| | Metric: MVS_JOB_EnclaveTime |
| | MVS_JOB_EnclaveTimeTotal |
+------------------+--------------------------------------------------+
| TimeIFA | IFA time. |
| | |
| | Source: ASSB.ASSB_TIME_ON_IFA |
| | |
| | This value is NOT normalized. |
| | |
| | Metric:MVS_JOB_IfaNonEnclave |
| | MVS_JOB_IfaNonEnclaveTotal |
+------------------+--------------------------------------------------+
| IFAonCP | IFA time on CP. |
| | |
| | Source: ASSB.ASSB_TIME_IFA_ON_CP |
| | |
| | Metric: MVS_JOB_IfaEligibleOnCp |
| | MVS_JOB_IfaEligibleOnCpTotal |
+------------------+--------------------------------------------------+
| IFAENCT | Enclave IFA time in the address space. |
| | |
| | Source: ASSB.ASSB_IFA_ENCT |
| | |
| | Metric: MVS_JOB_EnclaveIfaTime |
| | MVS_JOB_EnclaveIfaTimeTotal |
+------------------+--------------------------------------------------+
| IFACPENC | Enclave time for IFA on CP in the address space. |
| | |
| | Source: ASSB.ASSB_IFA_ON_CP_ENCT |
| | |
| | Metric: MVS_JOB_EnclaveIfaTimeOnCpu |
+------------------+--------------------------------------------------+
| IFACPENB | Enclave base time for IFA on CP in the address |
| | space. |
| | |
| | Source: ASSB.ASSB_IFA_ON_CP_BASE_ENCT |
+------------------+--------------------------------------------------+
| PHTMBase | Value of the ASSBPHTM at the end of the |
| | previous jobstep. |
| | |
| | Source: ASSB.ASSBPHTM_BASE |
+------------------+--------------------------------------------------+
| EnctBase | Value of the EnctBase at the end of the |
| | previous jobstep. |
| | |
| | Source: ASSB.ASSB_Base_ENCT |
+------------------+--------------------------------------------------+
| EIIPBase | Value of the EIIPBase at the end of the |
| | previous jobstep. |
| | |
| | Source: ASSB.ASSB_SUP_BASE_ENCT |
+------------------+--------------------------------------------------+
| EIFABase | Value of the EIFABase at the end of the |
| | previous jobstep. |
| | |
| | Source: ASSB.ASSB_IFA_Base_ENCT |
+------------------+--------------------------------------------------+
| ASSBIOCT | DIV/IO count |
| | |
| | Source: ASSB.ASSBIOCT |
+------------------+--------------------------------------------------+
| ASSBIIPT | IOS I/O interrept processing time |
| | |
| | Source: ASSB.ASSBIIPT |
+------------------+--------------------------------------------------+
| zAAPzIIP | When not zAAP-on-zIIP initially, this is |
| | incremented on switches to zAAP. When |
| | zAAP-on-zIIP initially, this is incremented on |
| | switches to both zAAP and zIIP. |
| | |
| | Source: ASSB.ASSB_SWITCH_TO_ZAAPZIIP_COUNT |
+------------------+--------------------------------------------------+
| CSA | The CSA storage used by the job. |
| | Requires the Virtual Storage Manager (VSM) |
| | tracking facility is active. |
| | |
| | Source: CAUB.CAUB_CSA_BELOW |
| | |
| | Metric: MVS_JOB_CsaUsed |
+------------------+--------------------------------------------------+
| E-CSA | The extended CSA storage used by the job. |
| | Requires the Virtual Storage Manager (VSM) |
| | tracking facility is active. |
| | |
| | Source: CAUB.CAUB_CSA_ABOVE |
| | |
| | Metric: MVS_JOB_EcsaUsed |
+------------------+--------------------------------------------------+
| RUCSA | The RUCSA storage used by the job. |
| | Requires the Virtual Storage Manager (VSM) |
| | tracking facility is active. |
| | |
| | Source CAUB_RUCSA_EXTENSION.CAUB_RUCSA_BELOW |
| | |
| | Metric: MVS_JOB_RucsaUsed |
+------------------+--------------------------------------------------+
| E-RUCSA | The extended RUCSA storage used by the job. |
| | Requires the Virtual Storage Manager (VSM) |
| | tracking facility is active. |
| | |
| | Source CAUB_RUCSA_EXTENSION.CAUB_RUCSA_ABOVE |
| | |
| | Metric: MVS_JOB_ErucsaUsed |
+------------------+--------------------------------------------------+
| SQA | The SQA storage used by the job. |
| | Requires the Virtual Storage Manager (VSM) |
| | tracking facility is active. |
| | |
| | Source: CAUB.CAUB_SQA_BELOW |
| | |
| | Metric: MVS_JOB_SqaUsed |
+------------------+--------------------------------------------------+
| E-SQA | The extended SQA storage used by the job. |
| | Requires the Virtual Storage Manager (VSM) |
| | tracking facility is active. |
| | |
| | Source: CAUB.CAUB_SQA_ABOVE |
| | |
| | Metric: MVS_JOB_EsqaUsed |
+------------------+--------------------------------------------------+
| G-CSA | The amount of 64-bit common storage allocated |
| | with this ASID as the owner. |
| | |
| | Source: RAX.RAXHVCommonBytes |
| | |
| | Metric: MVS_JOB_GcomAlloc |
+------------------+--------------------------------------------------+
| G-PVT | The amount of allocated 64-bit private storage |
| | |
| | Source: RAX.RAXLVABYTES |
| | |
| | Metric: MVS_JOB_GpvtAlloc |
+------------------+--------------------------------------------------+
| ASSBJBNI | Jobname for the Initiated program that is |
| | associated with this address space. |
| | |
| | Source: ASSB.ASSBJBNI |
+------------------+--------------------------------------------------+
| ASSBJBNS | Jobname for the START/MOUNT/LOGON that is |
| | associated with this address space. |
| | |
| | Source: ASSB.ASSBJBNS |
+------------------+--------------------------------------------------+
| ASCB | The ASCB address for the job. |
+------------------+--------------------------------------------------+
| ASSB | The ASSB address for the job. |
+------------------+--------------------------------------------------+
| Description | A description of the address space based on the |
| | jobname. The description for a jobname is |
| | defined in the parmlib member JOBNAMES. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.
Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| LISTFile | Invokes the LISTFILE command for the selected |
| LF | jobname. |
+------------------+--------------------------------------------------+
| JJobque | Invokes the JJOBQUE command for the selected |
| LJ | jobname. |
+------------------+--------------------------------------------------+
| STEPSUM | Invokes the STEPSUM command for the selected |
| SS | jobname. |
+------------------+--------------------------------------------------+
| ASCB | Invokes the DUMP command to display the virtual |
| | storage for the ASCB address. |
+------------------+--------------------------------------------------+
| ASSB | Invokes the DUMP command to display the virtual |
| | storage for the ASSB address. |
+------------------+--------------------------------------------------+
| MAPASCB | Invokes the MAP command for the selected |
| | jobname and ASCB control block. |
+------------------+--------------------------------------------------+
| MAPASSB | Invokes the MAP command for the selected |
| | jobname and ASSB control block. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
ASQUERY

ASQUERY Command

The ASQUERY command is used to query identifying information


about an address space. The output of the ASQUERY command is
a message containing the ASID of the target address space,
job name, job identifier (if any), and address space type.

Command Syntax

+---------------+-----------------------------------------------------+
| ASQuery | [asid] [TYPE astype] [infokwd] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| asid | The address space to be queried. The ASID |
| | parameter can be specified using one of the |
| | following forms: |
| | |
| | hexasid A hexadecimal ASID specified as |
| | 1 to 4 hexadecimal digits |
| | |
| | decasid A decimal ASID specified as 1 to |
| | 5 decimal digits followed by a |
| | decimal point |
| | |
| | identifier A 1 to 8 character started task |
| | identifier. For started tasks |
| | that are started using the |
| | format "procname.identifier" |
| | |
| | jobname A 1- to 8-character jobname. |
| | The jobname must be enclosed |
| | character delimiters if it would |
| | otherwise be recognized as a |
| | hexadecimal ASID. |
| | |
| | jobnumber A 1- to 5-character JES job |
| | number prefixed with a J. The |
| | job number can be for a batch |
| | job, a TSO user, or a started |
| | task. |
| | |
| | jobid A 1- to 5-character JES job |
| | number prefixed by JOB, TSU, or |
| | STC, for batch jobs, TSO users, |
| | and started tasks, respectively. |
| | The prefix used must match the |
| | prefix of the actual job. |
| | |
| | * The current target address space |
| | |
| | keyword A keyword from the following |
| | list: |
| | |
| | CURR The current target |
| | address space. |
| | |
| | HOME The home address |
| | space. |
| | |
| | NEXT The next active |
| | address space after |
| | the current target |
| | address space. |
| | |
| | PREV The previous active |
| | address space before |
| | the current target |
| | address space. |
| | |
| | FIRST The first active |
| | address space. |
| | |
| | LAST The last active |
| | address space. |
| | |
| | The current target ASID is used as a default if |
| | the ASID parameter is omitted. |
| | |
+------------------+--------------------------------------------------+
| TYPE astype | The TYPE parameter can only be specified when |
| | the asid parameter is a job name or the FIRST, |
| | NEXT, PREVIOUS, or LAST keywords. |
| | |
| | It is used to restrict the possible match |
| | to a specific address space type. The astype |
| | value must be one of the following keywords: |
| | |
| | ANY Any address space type. |
| | This is the default. |
| | ATX An APPC transaction. |
| | INIT An initiator. |
| | JOB A batch job. |
| | OTX An OMVS transaction. |
| | STC A started task. |
| | SYS A system task. |
| | TSU A TSO user. |
| | |
+------------------+--------------------------------------------------+
| infokwd | Query information request keyword. |
| | |
| | Can be one of the following values. If more |
| | than one is specified only the last will be |
| | used. |
| | |
| | If none of these values are specified then just |
| | the basic ASID information is displayed. |
| | The basic information is the ASID, Jobname, |
| | Jobid, and address space type for the requested |
| | asid parameter. |
| | |
| | DPRTY Dispatch priority. |
| | |
| | EPVTLIMIT Extended private region |
| | size limit. |
| | |
| | MEMLIMIT Memory limit on the total |
| | number of virtual storage |
| | pages above the bar. |
| | |
| | SERVICECLASS Service class name. |
| | |
| | QUIESCED Quiesced indicator. |
| | |
| | DESCRIPTION Jobname description. |
| | Descriptions are obtained |
| | from the JOBNAMES parmlib |
| | member. |
| | |
+------------------+--------------------------------------------------+
ASQUIESC

ASQUIESC Command

The ASQUIESC command is used to quiesce an address space.

Command Syntax

+---------------+-----------------------------------------------------+
| ASQUIesc | asid [JOBname jobname] [TYPE astype] [opts] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| asid | The ASID parameter identifies the address space |
| | to be quiesced. The ASID parameter can be |
| | specified using one of the following forms: |
| | |
| | hexasid A hexadecimal ASID specified as |
| | 1 to 4 hexadecimal digits. |
| | |
| | decasid A decimal ASID specified as 1 to |
| | 5 decimal digits followed by a |
| | decimal point. |
| | |
| | jobname A 1 to 8 character jobname. The |
| | jobname must be enclosed |
| | character delimiters if it would |
| | otherwise be recognized as a |
| | hexadecimal ASID. |
| | |
| | jobnumber A 1 to 5 character JES job |
| | number with a "J" prefix. The |
| | job number can be for a batch |
| | job, a TSO user, or a started |
| | task. |
| | |
| | jobid A 1 to 5 character JES job |
| | number prefixed by "JOB", "TSU", |
| | or "STC", for batch jobs, TSO |
| | users, and started tasks, |
| | respectively. The prefix used |
| | must match the prefix of the |
| | actual job. |
| | |
+------------------+--------------------------------------------------+
| JOBname jobname | The JOBNAME parameter must be specified when |
| | the asid parameter is a hexasid or decasid. |
| | |
| | The job name is used to verify and ensure a |
| | match with the job name executing in the |
| | specified asid. |
| | |
| | The JOBNAME parameter will be ignored for |
| | asid parameters other than hexasid or decasid. |
| | |
+------------------+--------------------------------------------------+
| TYPE astype | The TYPE parameter can only be specified |
| | when the asid parameter is a job name. |
| | |
| | It is used to restrict the possible match |
| | to a specific address space type. The astype |
| | value must be one of the following keywords: |
| | |
| | ANY Any address space type. |
| | This is the default. |
| | ATX An APPC transaction. |
| | INIT An initiator. |
| | JOB A batch job. |
| | OTX An OMVS transaction. |
| | STC A started task. |
| | SYS A system task. |
| | TSU A TSO user. |
| | |
+------------------+--------------------------------------------------+
| opts | Optional keyword parameters. Specify any number |
| | in any order from the following list: |
| | |
| | NOConfirm Controls whether you are |
| | Confirm prompted to confirm your |
| | intention. The default is |
| | CONFIRM. |
| | |
| | NOMessage Controls whether a "Command |
| | Message issued" message is generated |
| | generated at the successful |
| | completion of the command. The |
| | default is MESSAGE. |
| | |
| | The default values for the options listed above |
| | can be changed using the ASOPTION command. The |
| | defaults listed here are the original default |
| | values as the product is distributed. |
| | |
+------------------+--------------------------------------------------+
ASRESUME

ASRESUME Command

The ASRESUME command is used to resume a previously


quiesced address space or to reclassify work currently
in execution according to the service policy in effect.

Command Syntax

+---------------+-----------------------------------------------------+
| ASResume | asid [JOBname jobname] [TYPE astype] [opts] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| asid | The ASID parameter identifies the address space |
| | to be resumed. The ASID parameter can be |
| | specified using one of the following forms: |
| | |
| | hexasid A hexadecimal ASID specified as |
| | 1 to 4 hexadecimal digits. |
| | |
| | decasid A decimal ASID specified as 1 to |
| | 5 decimal digits followed by a |
| | decimal point. |
| | |
| | jobname A 1 to 8 character jobname. The |
| | jobname must be enclosed |
| | character delimiters if it would |
| | otherwise be recognized as a |
| | hexadecimal ASID. |
| | |
| | jobnumber A 1 to 5 character JES job |
| | number with a "J" prefix. The |
| | job number can be for a batch |
| | job, a TSO user, or a started |
| | task. |
| | |
| | jobid A 1 to 5 character JES job |
| | number prefixed by "JOB", "TSU", |
| | or "STC", for batch jobs, TSO |
| | users, and started tasks, |
| | respectively. The prefix used |
| | must match the prefix of the |
| | actual job. |
| | |
+------------------+--------------------------------------------------+
| JOBname jobname | The JOBNAME parameter must be specified when |
| | the asid parameter is a hexasid or decasid. |
| | |
| | The job name is used to verify and ensure a |
| | match with the job name executing in the |
| | specified asid. |
| | |
| | The JOBNAME parameter will be ignored for |
| | asid parameters other than hexasid or decasid. |
| | |
+------------------+--------------------------------------------------+
| TYPE astype | The TYPE parameter can only be specified |
| | when the asid parameter is a job name. |
| | |
| | It is used to restrict the possible match |
| | to a specific address space type. The astype |
| | value must be one of the following keywords: |
| | |
| | ANY Any address space type. |
| | This is the default. |
| | ATX An APPC transaction. |
| | INIT An initiator. |
| | JOB A batch job. |
| | OTX An OMVS transaction. |
| | STC A started task. |
| | SYS A system task. |
| | TSU A TSO user. |
| | |
+------------------+--------------------------------------------------+
| opts | Optional keyword parameters. Specify any number |
| | in any order from the following list: |
| | |
| | NOConfirm Controls whether you are |
| | Confirm prompted to confirm your |
| | intention. The default is |
| | CONFIRM. |
| | |
| | NOMessage Controls whether a "Command |
| | Message issued" message is generated |
| | generated at the successful |
| | completion of the command. The |
| | default is MESSAGE. |
| | |
| | The default values for the options listed above |
| | can be changed using the ASOPTION command. The |
| | defaults listed here are the original default |
| | values as the product is distributed. |
| | |
+------------------+--------------------------------------------------+
ASSET

ASSET Command

The ASSET command provides a set of functions that can take actions
on an address space. The functions are used to alter specific
resources. Some of these functions are also available as line
commands on other display commands.

Command Syntax

+------------------+--------------------------------------------------+
| ASSet | [asid] function [value] |
| | [JOBname jobname] |
| | [TYPE astype ] |
| | [opts] |
+------------------+--------------------------------------------------+
| | Function and parameter syntax examples: |
| | |
| | Function Parameters |
| | ------------ ----------- |
| | DPRTY priority |
| | EPVTLIM limit |
| | GPVTLIM limit |
| | SRVCLASS class |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| asid | The ASID parameter identifies the address space |
| | to which the action is to be issued. |
| | |
| | If "asid" is not specifed, the current asid |
| | will be used. |
| | |
| | The ASID parameter can be specified using one |
| | of the following forms: |
| | |
| | hexasid A hexadecimal ASID specified as |
| | 1 to 4 hexadecimal digits. |
| | |
| | decasid A decimal ASID specified as 1 to |
| | 5 decimal digits followed by a |
| | decimal point. |
| | |
| | identifier A 1 to 8 character started task |
| | identifier. For started tasks |
| | that are started using the |
| | format "procname.identifier". |
| | |
| | jobname A 1 to 8 character jobname. The |
| | jobname must be enclosed |
| | character delimiters if it would |
| | otherwise be recognized as a |
| | hexadecimal ASID. |
| | |
| | jobnumber A 1 to 5 character JES job |
| | number with a "J" prefix. The |
| | job number can be for a batch |
| | job, a TSO user, or a started |
| | task. |
| | |
| | jobid A 1 to 5 character JES job |
| | number prefixed by "JOB", "TSU", |
| | or "STC", for batch jobs, TSO |
| | users, and started tasks, |
| | respectively. The prefix used |
| | must match the prefix of the |
| | actual job. |
| | |
+------------------+--------------------------------------------------+
| JOBname jobname | The JOBNAME parameter must be specified when |
| | the asid parameter is a hexasid or decasid. |
| | |
| | The job name is used to verify and ensure a |
| | match with the job name executing in the |
| | specified asid. |
| | |
| | The JOBNAME parameter will be ignored for |
| | asid parameters other than hexasid or decasid. |
+------------------+--------------------------------------------------+
| TYPE astype | The TYPE parameter can only be specified |
| | when the asid parameter is a job name. |
| | |
| | It is used to restrict the possible match |
| | to a specific address space type. The astype |
| | value must be one of the following keywords: |
| | |
| | ANY Any address space type. |
| | This is the default. |
| | ATX An APPC transaction. |
| | INIT An initiator. |
| | JOB A batch job. |
| | OTX An OMVS transaction. |
| | STC A started task. |
| | SYS A system task. |
| | TSU A TSO user. |
| | |
+------------------+--------------------------------------------------+
| opts | Optional keyword parameters. Specify any number |
| | in any order from the following list: |
| | |
| | NOConfirm Controls whether you are |
| | Confirm prompted to confirm your |
| | intention. The default is |
| | CONFIRM. |
| | |
| | NOMessage Controls whether a "Command |
| | Message issued" message is generated |
| | generated at the successful |
| | completion of the command. The |
| | default is MESSAGE. |
| | |
| | The default values for the options listed above |
| | can be changed using the ASOPTION command. The |
| | defaults listed here are the original default |
| | values as the product is distributed. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Function | Specify the function to be executed. |
+------------------+--------------------------------------------------+
| DPRTY priority | Set dispatch priority. |
| | |
| | priority The new dispatch priority. If |
| | the first character of the |
| | priority value is an "X" then |
| | value will be interpreted as |
| | a hexadecimal value. The value |
| | must be from 0 to 255 (or X00 |
| | to XFF). |
| | |
| | Examples: |
| | |
| | ASSET JOBNAME1 DPRTY 255 |
| | ASSET JOBNAME2 DPRTY XFF |
| | |
+------------------+--------------------------------------------------+
| EPVTLIM limit | Set new extended private limit value. |
| | |
| | limit New E-PVT limit value. The |
| | value can be specified using |
| | storage suffixes such as K,M,G |
| | The value must be from 32M to |
| | 2047M. |
| | |
| | Example: |
| | |
| | ASSET SOMEJOB EPVTLIM 1024M |
| | |
+------------------+--------------------------------------------------+
| GPVTLIM limit | Set new grande private limit value. |
| | |
| | limit New G-PVT limit value. The |
| | value can be specified using |
| | storage suffixes such as K,M,G. |
| | The value must be from 1M to |
| | 16X. |
| | |
| | Example: |
| | |
| | ASSET SOMEJOB GPVTLIM 8G |
| | |
+------------------+--------------------------------------------------+
| SRVCLASS class | Set the WLM service class. |
| | |
| | class The new WLM service class. |
| | |
| | Example: |
| | |
| | ASSET SOMEJOB SRVCLASS HOTBATCH |
| | |
+------------------+--------------------------------------------------+
Messages

ASSE001W Requested limit value [newlimit] is not greater than current


value [current]

A request was made to alter the current limit value. The limit
value was not altered. The requested new limit value was not
larger than the current limit.

ASSE002I ASSET [asid] [jobname] [function] [value] complete

A request was made to perform a function on an address space.


This request has completed successfully.

ASSE003E ASSET function keyword not found

An ASSET command was issued that did not specify a function keyword.

ASSE004E Only one ASSET function keyword allowed

An ASSET command was issued that specified more than one function
keyword. Only one function keyword (and parameters) is allowed.

ASSE005E Value required for ASSET [func] function

The ASSET [func] function requires a value to be specified.


ATLIST

ATLIST Command

The ATLIST command lists information contained in the


Authorization Table.

Command Syntax

+---------------+------------------------------------------------------------+
| ATLIST | [asid] |
+---------------+------------------------------------------------------------+

Parameters

+----------------+-----------------------------------------------------------+
| Parameter | Explanation |
+----------------+-----------------------------------------------------------+
| asid | The ASID of the target address space. For details on |
| | specifying an ASID parameter see the ASID command. If |
| | the ASID parameter is omitted, then the current ASID is |
| | used. |
+----------------+-----------------------------------------------------------+

Information Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Jobname | The jobname of the current address space. |
+---------------+------------------------------------------------------------+
| ASID | The address space ID. |
+---------------+------------------------------------------------------------+
| Jobid | The job identifier. |
+---------------+------------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| AX | The authorization index. |
+---------------+------------------------------------------------------------+
| Stat | The status. This value is ACTV for the active entry. |
| | Otherwise, value is blank. |
+---------------+------------------------------------------------------------+
| PT | The PT authority. This value is PT if a program transfer |
| | is allowed into the home address space by routines |
| | executing with this AX. This value is blank if this is |
| | not allowed. |
+---------------+------------------------------------------------------------+
| SSAR | The SSAR authority. This value is SSAR if routines |
| | executing with this AX are allowed to establish secondary |
| | addressability to the home address space and if routines |
| | executing with this EAX are allowed to access the address |
| | space through access registers. This value is blank if |
| | this is not allowed. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. |
+---------------+------------------------------------------------------------+
ATTNX

ATTNX Command

The ATTNX command displays the TSO attention exit environment


and allows you to verify that an attention exit environment
has been properly established.

Command Syntax

+---------------+------------------------------------------------------------+
| ATTNX | [asid] |
+---------------+------------------------------------------------------------+

Parameters

+----------------+-----------------------------------------------------------+
| Parameter | Explanation |
+----------------+-----------------------------------------------------------+
| asid | The ASID of the target address space. For details on |
| | specifying an ASID parameter, see the ASID command. If |
| | the ASID parameter is omitted, then the current ASID is |
| | used. |
+----------------+-----------------------------------------------------------+

Information Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Jobname | The jobname of the current address space. |
+---------------+------------------------------------------------------------+
| ASID | The address space ID. |
+---------------+------------------------------------------------------------+
| Jobid | The job identifier. |
+---------------+------------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| TCB | The address of the TCB covered by the attention exit. |
+---------------+------------------------------------------------------------+
| Exit | The address of the attention exit. |
+---------------+------------------------------------------------------------+
| Region | The region where the exit address is located. |
+---------------+------------------------------------------------------------+
| Module | The module name for the exit. |
+---------------+------------------------------------------------------------+
| Offset | The offset within the module for the exit address. |
+---------------+------------------------------------------------------------+
| Parm | The parameter address. |
+---------------+------------------------------------------------------------+
| Defer | This field will display DEFER if the scheduling of the |
| | attention exit is currently deferred; otherwise it will |
| | be blank. |
+---------------+------------------------------------------------------------+
| Sched | This field will display SCHED if the attention exit has |
| | been scheduled; otherwise it will be blank. |
+---------------+------------------------------------------------------------+
| TopLv | This field will display TOPLV if the attention exit was |
| | established with the STAX macro TOPLEVL=YES operand; |
| | otherwise it is blank. An attention exit that specifies |
| | TOPLEVL=YES can not itself be interruped. |
+---------------+------------------------------------------------------------+
| Clist | This field will display the status of CLIST attention |
| | processing. Values can be |
| | |
| | CLSUP The attention exit supports CLIST attention |
| | processing but there is currently no CLIST |
| | ATTN statement active. |
| | |
| | CLACT The attention exit supports CLIST attention |
| | processing and there is currently a CLIST |
| | ATTN statement active. |
| | |
| | blank The attention exit does not support CLIST |
| | attention processing. |
| | |
+---------------+------------------------------------------------------------+
| TAXE | The TAXE address. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. |
+---------------+------------------------------------------------------------+
AUDITDEF

AUDITDEF Command

The AUDITDEF command displays the Audit Event definitions and


attributes.

Definitions can be added or maintained here (warm start) or


in parmlib member AUDITDEF (cold start).

Command Syntax

+------------------+--------------------------------------------------+
| AUDITDEF | [MODIFY event options] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Function | Specify the function to be executed. |
+------------------+--------------------------------------------------+
| MODIFY | Modify an existing audit event. |
| | Parms: |
| | event - Audit event name |
| | options - Event attributes |
| | Valid values are: |
| | ACTIVE |
| | INACTIVE |
| | SMF |
| | NOSMF |
| | LOG |
| | NOLOG |
| | OPSMVS |
| | NOOPSMVS |
| | WTO |
| | NOWTO |
| | DYNEXIT |
| | NODYNEXIT |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Logger | The current status of the Audit Event facility. |
+------------------+--------------------------------------------------+
| Records | The number of records that have been processed. |
+------------------+--------------------------------------------------+
| Segments | The internal log buffer segment size. |
+------------------+--------------------------------------------------+
| Count | The number of log buffers. |
+------------------+--------------------------------------------------+
| Buffer | The log buffer size. |
+------------------+--------------------------------------------------+
| Total | The total storage used by log buffers. |
+------------------+--------------------------------------------------+
| InUse | The percentage of log buffers in use. |
+------------------+--------------------------------------------------+
| Write | The number of write operations performed. |
+------------------+--------------------------------------------------+
| Post | The number of post operations performed. |
+------------------+--------------------------------------------------+
| Flush | The number of buffer flush operations performed. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: Event,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Event | The audit event name. |
| | Audit event descriptions |
+------------------+--------------------------------------------------+
| Type | The audit event type code. |
+------------------+--------------------------------------------------+
| Active | Specifies if the audit event is active. |
| | |
| | This field can be overtyped to alter the value. |
| | Valid values are: |
| | |
| | ACTIVE - Audit event is active |
| | INACTIVE - Audit event is inactive |
+------------------+--------------------------------------------------+
| SMF | Specifies if an audit event record is to be |
| | written to SMF. |
| | |
| | This field can be overtyped to alter the value. |
| | Valid values are: |
| | |
| | SMF - Record is to be written to SMF |
| | NOSMF - Record will not be written to SMF |
+------------------+--------------------------------------------------+
| Log | Specifies if an audit event record is to be |
| | written to the AUDIT log stream. |
| | |
| | This field can be overtyped to alter the value. |
| | Valid values are: |
| | |
| | LOG - Record is to be written to the |
| | AUDIT log stream. |
| | NOLOG - Record will not be written to the |
| | AUDIT log stream. |
+------------------+--------------------------------------------------+
| OPSMVS | Specifies if OPS/MVS is to be notified of the |
| | audit event. |
| | |
| | This field can be overtyped to alter the value. |
| | Valid values are: |
| | |
| | OPSMVS - Notification will be made. |
| | NOOPSMVS - Notification will not be made. |
+------------------+--------------------------------------------------+
| WTO | Specifies if a WTO message is to be written to |
| | make notification of the audit event. |
| | |
| | This field can be overtyped to alter the value. |
| | Valid values are: |
| | |
| | WTO - Notification will be made. |
| | NOWTO - Notification will not be made. |
+------------------+--------------------------------------------------+
| DynExit | Specifies if a dynamic exit will be called to |
| | notify interested parties of the audit event. |
| | |
| | The following information is passed to the |
| | caller in the parameter list: |
| | Parmlist: |
| | +00 - @ of record |
| | +04 - @ of Audit event name CL24 |
| | +08 - @ of Audit summary text CL256 |
| | |
| | This field can be overtyped to alter the value. |
| | Valid values are: |
| | |
| | DYNEXIT - Notification will be made. |
| | NODYNEXIT - Notification will not be made. |
+------------------+--------------------------------------------------+
| Count | The number of records that have been processed |
| | for this type. |
+------------------+--------------------------------------------------+
| MaxSz | The maximum record length that has been |
| | processed for this type. |
+------------------+--------------------------------------------------+
| Time | The time and date of the last audit event |
| | processed. |
+------------------+--------------------------------------------------+
| Date | The time and date of the last audit event |
| | processed. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the AUDITLOG command selecting the |
| | Event. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| EXPORT | Exports definitions to a specific member of |
| | a data set. |
| | |
| | Syntax: EXPORT member |
| | dsname(member) |
| | |
| | Parameter Description |
| | ---------- --------------------------------- |
| | member The name of the member to be |
| | saved. |
| | |
| | dsname The data set name where the |
| | specified member is saved. |
| | |
| | The data set name can be |
| | specified as a fully qualified |
| | data set name or using one of the |
| | following special keywords: |
| | |
| | Keyword Description |
| | ---------- ------------------------------- |
| | USER Uses the optional data set name |
| | defined in the user profile |
| | for the library type PARMLIB. |
| | |
| | Example: USER(member) |
| | |
| | SITE Uses the optional site PARMLIB |
| | data set that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITE(member) |
| | |
| | SYSTEM Uses the system PARMLIB data set |
| | that is defined in the system |
| | configuration options parmlib |
| | member: GSVXGSVX |
| | |
| | Example: SYSTEM(member) |
| | |
| | SITESYSTEM Uses the first defined data |
| | SITE.SYSTEM set from the following list |
| | * of eligible data set names: |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITESYSTEM(member) |
| | SITE.SYSTEM(member) |
| | *(member) |
| | |
| | USERSITE Uses the first defined data |
| | USER.SITE set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSITE(member) |
| | USER.SITE(member) |
| | |
| | USERSYSTEM Uses the first defined data |
| | USER.SYSTEM set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSYSTEM(member) |
| | USER.SYSTEM(member) |
| | |
| | The above keywords can be cursor selected |
| | invoking a hyperlink to the PARMLIB command |
| | showing the available data sets for the |
| | keyword. |
| | |
+------------------+--------------------------------------------------+
| MODIFY | Modify an existing audit event. |
| | |
| | Syntax: MODIFY event options |
| | |
| | event - Audit event name |
| | options - Event attributes |
| | Valid values are: |
| | ACTIVE |
| | INACTIVE |
| | SMF |
| | NOSMF |
| | LOG |
| | NOLOG |
| | OPSMVS |
| | NOOPSMVS |
| | WTO |
| | NOWTO |
| | DYNEXIT |
| | NODYNEXIT |
+------------------+--------------------------------------------------+
| RELOAD | Reload definitions. |
| | |
| | Syntax: RELOAD [member] |
| | |
| | * - Reload definitions from the |
| | blank persistent data store. If the |
| | WARM object is not found in the |
| | persistent data store, reload |
| | the definitions from parmlib. |
| | |
| | The default parmlib member to be |
| | used is AUDITDEF. |
| | |
| | DATALIB - Reload definitions from the |
| | persistent data store. |
| | |
| | COLD - Reload definitions from parmlib. |
| | |
| | member - Reload definitions from the |
| | specified parmlib member. |
| | |
| | The RELOAD function does not delete or empty |
| | the current set of definitions prior to |
| | attempting the reload. |
+------------------+--------------------------------------------------+
| SAVE | Save definitions to the persistent data store. |
+------------------+--------------------------------------------------+

Related Information

OPS/MVS Audit Event Notification

Security Requirements

A security check for the "MODIFY" subcommand will be performed if


a definition is altered.
AUDITLOG

AUDITLOG Command

The AUDITLOG command displays event records created by the Audit


Events component. To determine which audit events are active,
review the AUDITDEF parmlib member and the AUDITDEF command.

A log can potentially contain a very large number of records. For


this reason, only the specified number of records will be displayed.
This set of records is referred to as the "display window", and is
controlled by the LINES parameter on the command or the LINES
parameter on the OPTIONS subcommand.

Command Syntax

+------------------+--------------------------------------------------+
| | |
| &HelpMember | [ STREAM logstream ] |
| | |
| | [ DATE * | date ] |
| | [ TIME * | time ] |
| | |
| | [ READNext ] |
| | [ READPrev ] |
| | |
| | [ PERiod hh:mm:ss ] |
| | [ CUSHion hh:mm:ss ] |
| | |
| | [ LINEs datalines ] |
| | [ LIMit readlimit ] |
| | [ ELAPsedlimit hh:mm:ss ] |
| | |
| | [ RECtime END | START ] |
| | |
| | [ DISCARD ] |
| | [ NODISCARD ] |
| | |
| | [ FILTER ] |
| | [ NOFILTER ] |
| | |
| | [ ACCESS access ] |
| | [ BLD build ] |
| | [ COMMAND command ] |
| | [ EVENt event ] |
| | [ JOBname jobname ] |
| | [ RELS release ] |
| | [ SSID ssid ] |
| | [ SUBCMD subcommand ] |
| | [ SYStem system ] |
| | [ TASK taskname ] |
| | [ TASKID taskid ] |
| | [ TYPE type ] |
| | [ USERid userid ] |
| | |
+------------------+--------------------------------------------------+
Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| STREAM logstream | Specifies the log stream name from which to |
| | display data. |
| | |
| | If no log stream name is specified, the parmlib |
| | member LGLOOKUP will be used to locate a |
| | matching log stream name. |
| | |
| | Use the following "short" names to substitute |
| | the default log stream name for the indicated |
| | record type: |
| | |
| | AUDIT - Audit events |
| | CICSEITL - CICS EXEC interface trace log |
| | CICSSYSD - CICS system interval analysis |
| | CICSTRAN - CICS transaction log |
| | CICSTSUM - CICS transaction summary log |
| | CICSXLOG - CICS exception log |
| | CTGLOG - CICS Transaction Gateway log |
| | IMSIMTR - IMS transaction log |
| | IMSIMRS - IMS region summary log |
| | IMSIMTS - IMS transaction summary log |
| | IMSOMAT - IMS OM audit trail log |
| | MQSDATA - MQ request history log |
| | OPERLOG - Operations log stream |
| | PLOTLOG - Historical plot log |
| | SMFDATA - SMF log |
| | XLOG - Exception log |
| | ZCNRLOG - z/OS Connect request log |
| | |
+------------------+--------------------------------------------------+
| DATE date | Position to specified date in log. |
| | Read records from the starting point in a |
| | forward direction ( youngest to newest ). |
| | |
| | date - The date value must be specified |
| | using the date format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | Query current date format |
| | |
| | * - Use the current date (today). |
| | |
| | -days - Position to today's date |
| | minus the specified number |
| | of days. |
| | |
| | If a DATE value is supplied and a TIME |
| | value is not supplied, the current TIME (now) |
| | will be used. |
| | |
+------------------+--------------------------------------------------+
| TIME time | Position to specified time in log. |
| | |
| | time - The time value must be specified |
| | using the time format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | Query current time format |
| | |
| | * - Use the current time (now). |
| | |
| | nnAM - The time value can also be |
| | nnPM specified using one of the |
| | following values: |
| | 12AM | 1AM | 2AM | ... | 11AM |
| | 12PM | 1PM | 2PM | ... | 11PM |
| | NOON | MIDNIGHT |
| | |
| | -adjust - Set the time value to the |
| | +adjust current time (now) plus or minus |
| | the specified adjustment value. |
| | |
| | Example adjustment values: |
| | |
| | -0.500000 - 0.5 seconds |
| | -60 - 60 seconds |
| | -120Sec - 120 seconds |
| | -5MINutes - 5 minutes |
| | -1Hours - 1 hour |
| | -1Days - 1 day |
| | -hh:mm:ss - hours:minutes:seconds |
| | |
| | +0.500000 + 0.5 seconds |
| | +60 + 60 seconds |
| | +120Sec + 120 seconds |
| | +5MINutes + 5 minutes |
| | +1Hours + 1 hour |
| | +1Days + 1 day |
| | +hh:mm:ss + hours:minutes:seconds |
| | |
| | If a TIME value is supplied and a DATE |
| | value is not supplied, the current DATE |
| | will be used. |
| | |
+------------------+--------------------------------------------------+
| READPrev | If a date or time value is specified, READPREV |
| | specifies that the log is to be read starting |
| | at the date and time and read backwards |
| | (youngest to oldest). |
| | |
| | If date or time is not specified, the READPREV |
| | parameter is ignored. |
| | |
+------------------+--------------------------------------------------+
| READNext | If a date or time value is specified, READNEXT |
| | specifies that the log is to be read starting |
| | at the date and time and read forwards |
| | (oldest to youngest). |
| | |
| | If date or time is not specified, the READNEXT |
| | parameter is ignored. |
| | |
+------------------+--------------------------------------------------+
| PERiod hh:mm:ss | Specifies the time period for which records are |
| | to be displayed. |
| | |
| | Default : 0 (unlimited) |
| | |
| | Example values: |
| | |
| | NONE - No period (unlimited) |
| | 0 - No period (unlimited) |
| | 0.500000 - 0.5 seconds |
| | 60 - 60 seconds |
| | 120Sec - 120 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | 1Days - 1 day |
| | 1MONths - 1 month |
| | 1Years - 1 year |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| CUSHion hh:mm:ss | Specifies the time period cushion for which |
| | records are to be read for display. |
| | |
| | Data records stored in an MVS log stream are |
| | sequenced or sorted based on the actual time |
| | the record was written to the stream. |
| | |
| | This does not guarantee that the records are |
| | sorted in a time sequence based on the |
| | date and time information that is potentially |
| | contained within each record. |
| | |
| | For this reason, when a user wants to display |
| | a specific time period of data, additional |
| | records must be read on the front and back |
| | end of the read process to ensure that the |
| | records that might be out of sequence are |
| | included. |
| | |
| | The time period cushion specifies the extra |
| | records to be read. |
| | |
| | Example Cushion: |
| | |
| | Start time: 8AM |
| | Period : 1 Hour |
| | Cushion : 5 minutes |
| | |
| | Read Begin : 07:55:00 |
| | -- Discard records |
| | Display Begin : 08:00:00 |
| | -- Display records |
| | Display End : 09:00:00 |
| | -- Discard records |
| | Read End : 09:05:00 |
| | |
| | Example values: |
| | |
| | NONE - No cushion |
| | 0 - No cushion |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| LINEs count | Specifies the maximum number of data rows to |
| | be displayed. |
| | |
| | Default : 25000 |
| | Minimum : 1 |
| | Maximum : 1000000 |
| | |
| | Specifying the LINES value with the primary |
| | command syntax does not alter or change the |
| | default value stored in the user profile. |
| | |
| | The default value can be altered using the |
| | subcommand: OPTIONS LINES count |
| | |
| | The actual number of data rows displayed may |
| | be greater than the specified LINES value if |
| | a record or message expanded to multiple lines. |
| | |
+------------------+--------------------------------------------------+
| LIMit count | Specifies the maximum number of records to be |
| | read. |
| | |
| | Specifying the LIMIT value with the primary |
| | command syntax does not alter or change the |
| | default value stored in the user profile. |
| | |
| | The default value can be altered using the |
| | subcommand: OPTIONS LIMIT count |
| | |
| | Default : 1000000 |
| | |
+------------------+--------------------------------------------------+
| ELAPsed hh:mm:ss | Specifies the elapsed time limit for reading |
| | or searching the log streams for desired |
| | data. |
| | |
| | If the log stream being searched is very large, |
| | the search time required can be substantial. |
| | This is especially true if a large number |
| | of data LINES has been requested and the |
| | number of data records that would satisfy |
| | the search request are spread across the |
| | entire log stream. |
| | |
| | The log browse search will be interrupted |
| | when the elapsed time limit is reached. |
| | |
| | The search can be continued using the |
| | subcommands: NEXT or PREVIOUS |
| | |
| | Example values: |
| | |
| | NONE - No timeout |
| | 0 - No timeout |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| RECORDTime | Specifies whether the "start" or "end" date |
| RECTime | and time should be used for the records. |
| | |
| | Not all records have a start and an end |
| | time. Records that do not have both a start |
| | and an end time are considered "events". |
| | |
| | Records that are interval based typically |
| | do have a start and end time. |
| | |
| | Records that are event based typically do not. |
| | |
| | Valid values: |
| | |
| | END |
| | START |
| | EVENT |
| | |
+------------------+--------------------------------------------------+
| DISCard | Specifies whether records found to be in the |
| NODISCard | time period cushion should be discarded or |
| | kept. |
| | |
| | DISCARD - Discard the records found in |
| | the cushion. (default) |
| | |
| | NODISCARD - Keep the records found in the |
| | cushion. |
| | |
+------------------+--------------------------------------------------+
| FILTER | Display a "filter" screen to allow the |
| NOFILTER | entering of command syntax parameters to |
| | filter the data. |
| | |
| | When the "FILTER" keyword is entered as part |
| | of the primary command, the parameters entered |
| | will be used to populate the filter display. |
| | |
| | After entering desired data on the filter |
| | display, the following function keys can |
| | be used: |
| | |
| | ENTER - Validate the data entered. |
| | No processing occurs. |
| | |
| | F1 - Invoke HELP for the filter display. |
| | |
| | F3 - Validate the data entered and |
| | process the data to build the |
| | display. |
| | |
| | F12 - Do not validate data. No processing |
| | occurs. The existing data is |
| | redisplayed. |
| | |
| | FILTER - Display filter. |
| | |
| | NOFILTER - Do not display filter (default). |
| | |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| ACCESS | Display only those commands,subcommands, or |
| | actions that had the specified security |
| | result. |
| | |
| | Valid values are: |
| | ALLOWED |
| | FAILED |
| | |
| | Valid for the following event types: |
| | COMMAND_PRIMARY |
| | COMMAND_SUBCOMMAND |
| | COMMAND_ACTION |
| | SECURITY_RESOURCE |
| | |
| | Syntax: ACCESS ALLOWED|FAILED |
+------------------+--------------------------------------------------+
| BLD | Display only those audit events that were |
| | created by the specified product build number. |
| | Syntax: BLD build |
+------------------+--------------------------------------------------+
| COMMAND | Display only those entries with the specified |
| | command name. |
| | |
| | Valid for the following event types: |
| | COMMAND_PRIMARY |
| | COMMAND_SUBCOMMAND |
| | COMMAND_ACTION |
| | SECURITY_RESOURCE |
| | |
| | Syntax: COMMAND command |
+------------------+--------------------------------------------------+
| EVENt | Specifies the audit event that is to be |
| | displayed. |
| | Valid values are: |
| | See AUDITDEF command |
| | Syntax: EVENT event |
+------------------+--------------------------------------------------+
| JOBname | Display only those audit events that were |
| | created by the specified jobname. |
| | Syntax: JOBNAME jobname |
+------------------+--------------------------------------------------+
| RELS | Display only those audit events that were |
| | created by the specified product release. |
| | Syntax: RELS release |
+------------------+--------------------------------------------------+
| SSID | Display only those audit events that were |
| | created on the specified subsystem. |
| | Syntax: SSID ssid |
+------------------+--------------------------------------------------+
| SUBCMD | Display only those entries with the specified |
| | subcommand or action. |
| | |
| | Valid for the following event type: |
| | COMMAND_SUBCOMMAND |
| | COMMAND_ACTION |
| | SECURITY_RESOURCE |
| | |
| | Syntax: SUBCMD subcmd|action |
+------------------+--------------------------------------------------+
| SYStem | Display only those audit events that were |
| | created on the specified system. |
| | Syntax: SYSTEM system |
+------------------+--------------------------------------------------+
| TASK | Display only those audit events that were |
| | created by the specified task name. |
| | Syntax: TASK taskname |
+------------------+--------------------------------------------------+
| TASKID | Display only those audit events that were |
| | created by the specified task Id. |
| | Syntax: TASKID taskid |
+------------------+--------------------------------------------------+
| TYPE | Specifies the audit event code type that is to |
| | be displayed. |
| | Valid values are: |
| | See AUDITDEF command |
| | Syntax: TYPE type |
+------------------+--------------------------------------------------+
| USERid | Display only those audit events that were |
| | created by the specified userid. |
| | Syntax: USERID userid |
+------------------+--------------------------------------------------+

Information Fields

The Information Section area is cursor selectable.


If the cursor is in the Information Section and the [ENTER] key
is pressed, the "FILTER" panel will be displayed.

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| LogStream | The name of the log stream from which data |
| | is being displayed. |
| | |
| | The keyword "ASIS" will follow the log stream |
| | name if the records are being read ASIS. |
| | ASIS specifies that no record decompression |
| | has been requested. |
+------------------+--------------------------------------------------+
| Retention | The log stream retention period. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Available | The time and date of the first and last records |
| | in the physical log stream. |
| | |
| | Commands that display the contents of log |
| | streams will only display those records that |
| | are relevant to the specific command. The log |
| | stream may contain other records. |
| | |
| | The available time and date information may not |
| | reflect the actual usable data records if the |
| | log stream contains data different than what |
| | corresponds to the active command. |
+------------------+--------------------------------------------------+
| Searched | The searched range of records processed. |
+------------------+--------------------------------------------------+
| Displayed | The current "display window" of records being |
| | displayed. |
| | |
| | The time and date of the first and last records |
| | displayed. |
| | |
| | This value can be modified to position to a new |
| | starting time and date. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Lines | Specifies the maximum number of data rows |
| | to be displayed. |
+------------------+--------------------------------------------------+
| Limit | Specifies the maximum number of records to be |
| | read in order to satisfy the specified "Lines" |
| | value. |
| | The value "NONE" indicates that no limit or |
| | "0" was specified. |
+------------------+--------------------------------------------------+
| Period | Specifies the time period for which records are |
| | to be displayed. |
| | The value "NONE" indicates that no time period |
| | was specified. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Date | The date and time of the record. |
| Time | |
+------------------+--------------------------------------------------+
| Type | The audit event type code. |
+------------------+--------------------------------------------------+
| Event | The audit event name. |
| | Audit event descriptions |
+------------------+--------------------------------------------------+
| Resource | A short summary of record data. |
+------------------+--------------------------------------------------+
| Userid | The userid that created the event record. |
+------------------+--------------------------------------------------+
| Task | The task name that created the event record. |
+------------------+--------------------------------------------------+
| TaskId | The task Id that created the event record. |
+------------------+--------------------------------------------------+
| System | The system name where the event record was |
| | created. |
+------------------+--------------------------------------------------+
| SSID | The subsystem where the event record was |
| | created. |
+------------------+--------------------------------------------------+
| Rels | The product release from where the event |
| | record was created. |
+------------------+--------------------------------------------------+
| Bld | The product build number from where the event |
| | record was created. |
+------------------+--------------------------------------------------+
| Jobname | The jobname from where the event record was |
| | created. |
+------------------+--------------------------------------------------+
| JobId | The job ID from where the event record was |
| | created. |
+------------------+--------------------------------------------------+
| ASID | The ASID of the job from where the event record |
| | was created. |
+------------------+--------------------------------------------------+
| Terminal | The terminal name from where the event record |
| | was created. |
+------------------+--------------------------------------------------+
| Interface | The interface name from where the event record |
| | was created. |
+------------------+--------------------------------------------------+
| Profile | The profile name of the user that created the |
| | event record. |
+------------------+--------------------------------------------------+
| SecGroup | The security group of the user that created the |
| | event record. |
+------------------+--------------------------------------------------+
| UserName | The user name that created the event record. |
+------------------+--------------------------------------------------+
| Access | Security access result for commands, subcommands,|
| | and actions. |
| | |
| | Possible values are: |
| | ALLOWED |
| | FAILED |
| | |
| | Valid for the following event types: |
| | COMMAND_PRIMARY |
| | COMMAND_SUBCOMMAND |
| | COMMAND_ACTION |
| | SECURITY_RESOURCE |
+------------------+--------------------------------------------------+
| Command | Command name |
| | |
| | Valid for the following event types: |
| | COMMAND_PRIMARY |
| | COMMAND_SUBCOMMAND |
| | COMMAND_ACTION |
| | SECURITY_RESOURCE |
+------------------+--------------------------------------------------+
| SubCmd | Subcommand or Action name |
| | |
| | Valid for the following event type: |
| | COMMAND_SUBCOMMAND |
| | COMMAND_ACTION |
| | SECURITY_RESOURCE |
+------------------+--------------------------------------------------+
| Type | The record type. |
+------------------+--------------------------------------------------+
| Length | The record length. |
+------------------+--------------------------------------------------+
| BlockID | Block ID assigned to the log record. |
+------------------+--------------------------------------------------+
| SubRec | Sub-record number within a block. |
+------------------+--------------------------------------------------+
| CmpLen | Length of the compressed record |
+------------------+--------------------------------------------------+
| Cmp% | Compression percentage |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DRO | Delete records older than the entry selected. |
| | Invokes the LGDRO command. |
+------------------+--------------------------------------------------+
| PRint | Displays the detail screen for a record, prints |
| | the detail report to a sysout data set and then |
| | returns to the display screen. If a SYSOUT |
| | print data set was not open this line command |
| | will cause it to be opened. All subsequent |
| | PRINT line commands will print to the same |
| | SYSOUT data set until a PRINT CLOSE command is |
| | issued or until the session terminates. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Dump | Dump the contents of a record. |
+------------------+--------------------------------------------------+
| SD | Select and dump. |
| | |
| | A detailed report followed by a dump of the |
| | contents of the record is displayed. |
+------------------+--------------------------------------------------+
| Select | Display the detail screen for a record. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| BACkward | Read the previous block of records in the log |
| PREVious | starting with the first record displayed on the |
| | screen. The number of records read is |
| | controlled by the LINES option, which can be set |
| | using the OPTIONS subcommand. |
+------------------+--------------------------------------------------+
| EOF | Go to the end of the log. |
| EOL | |
+------------------+--------------------------------------------------+
| FORward | Read the next block of records in the log |
| NEXT | starting with the last record displayed on the |
| | screen. The number of records read is |
| | controlled by the LINES option, which can be set |
| | using the OPTIONS subcommand. |
+------------------+--------------------------------------------------+
| OPTions | Set and display miscellaneous command options. |
+------------------+--------------------------------------------------+
| POSition | Position to a time and date. |
| | |
| | Syntax : POSITION time [date] |
| | |
| | time - The time value must be specified |
| | using the time format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | If "*" is specified, the current |
| | time will be used. |
| | |
| | The time value can also be |
| | specified using one of the |
| | following values: |
| | 12AM | 1AM | 2AM | ... | 11AM |
| | 12PM | 1PM | 2PM | ... | 11PM |
| | NOON | MIDNIGHT |
| | |
| | Query current time format |
| | |
| | date - The date value must be specified |
| | using the date format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | If "*" is specified, the current |
| | date will be used. |
| | |
| | Query current date format |
| | |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| TOF | Go to the top of the log. |
| TOL | |
+------------------+--------------------------------------------------+
| FILTER | Display a "filter" screen to allow the entering |
| | command syntax parameters to filter the data. |
+------------------+--------------------------------------------------+

OPTIONS Subcommand

The OPTIONS subcommand sets and displays miscellaneous command


options.

Entering the OPTIONS subcommand with no parameters displays the


current option values.

Multiple option values can be entered as a single command.

OPTIONS Subcommand format

+------------------+--------------------------------------------------+
| OPTIONS | [options] |
+------------------+--------------------------------------------------+

OPTIONS Subcommand Parameter Values

+------------------+--------------------------------------------------+
| Value | Explanation |
+------------------+--------------------------------------------------+
| LINEs | Specifies the maximum number of data rows to |
| | be displayed. |
| | |
| | Syntax : OPTIONS LINES count |
| | |
| | Default : 25000 |
| | Minimum : 1 |
| | Maximum : 1000000 |
| | |
+------------------+--------------------------------------------------+
| LIMit | Specifies the maximum number of records to be |
| | read. |
| | |
| | Syntax : OPTIONS LIMIT count |
| | |
| | Default : 1000000 |
| | |
+------------------+--------------------------------------------------+
| PERiod | Specifies the time period for which records are |
| | to be displayed. |
| | |
| | Syntax : OPTIONS PERIOD hh:mm:ss |
| | |
| | Default : 0 (unlimited) |
| | |
| | Example values: |
| | |
| | NONE - No period (unlimited) |
| | 0 - No period (unlimited) |
| | 0.500000 - 0.5 seconds |
| | 60 - 60 seconds |
| | 120Sec - 120 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | 1Days - 1 day |
| | 1MONths - 1 month |
| | 1Years - 1 year |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| CUSHion | Specifies the time period cushion for which |
| | records are to be read for display. |
| | |
| | Data records stored in an MVS log stream are |
| | sequenced or sorted based on the actual time |
| | the record was written to the stream. |
| | |
| | This does not guarantee that the records |
| | are sorted in a time sequence based on the |
| | date and time information that is potentially |
| | contained within each record. |
| | |
| | For this reason, when a user wants to display |
| | a specific time period of data, additional |
| | records must be read on the front and back |
| | end of the read process to ensure that the |
| | records that might be out of sequence are |
| | included. |
| | |
| | The time period cushion specifies the extra |
| | records to be read. |
| | |
| | Syntax : OPTIONS CUSHION hh:mm:ss |
| | |
| | Example Cushion: |
| | |
| | Start time: 8AM |
| | Period : 1 Hour |
| | Cushion : 5 minutes |
| | |
| | Read Begin : 07:55:00 |
| | -- Discard records |
| | Display Begin : 08:00:00 |
| | -- Display records |
| | Display End : 09:00:00 |
| | -- Discard records |
| | Read End : 09:05:00 |
| | |
| | Example values: |
| | |
| | NONE - No cushion |
| | 0 - No cushion |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| ELAPsed | Specifies the elapsed time limit for reading |
| ELAPsedlimit | or searching the log streams for desired data. |
| | |
| | If the log stream being searched is very large, |
| | the search time required can be substantial. |
| | This is especially true if a large number of |
| | data LINES has been requested and the number |
| | of data records that would satisfy the search |
| | request are spread across the entire log stream. |
| | |
| | The log browse search will be interrupted |
| | when the elapsed time limit is reached. |
| | |
| | The search can be continued using the |
| | subcommands: NEXT or PREVIOUS |
| | |
| | Syntax : OPTIONS ELAPSED hh:mm:ss |
| | |
| | Default : 00:00:30 |
| | |
| | Example values: |
| | |
| | NONE - No limit |
| | 0 - No limit |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| RECORDTime | Specifies whether the "start" or "end" date |
| RECTime | and time should be used for the records. |
| | |
| | Not all records have a start and an end time. |
| | |
| | Records that are interval based typically do |
| | have a start and end time. |
| | |
| | Records that are event based typically do not. |
| | |
| | Syntax : OPTIONS RECTIME END|START |
| | |
| | Valid values are: |
| | |
| | END (default) |
| | START |
| | |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC |
| | variable. The variable created or updated is |
| | named SYSV_OPTIONS_cmdname. EXTRACT is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. EXTRACT can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+------------------+--------------------------------------------------+
| FILTER | Specifies that the "filter" display screen |
| | is to be displayed to allow the entering of |
| | command syntax parameters. |
| | |
| | The "filter" display screen will be displayed |
| | each time the command is invoked unless the |
| | NOFILTER parameter is entered as part of the |
| | primary command syntax. |
| | |
| | Syntax : OPTIONS FILTER |
| | |
+------------------+--------------------------------------------------+
| NOFILTER | Specifies that the "filter" display screen |
| | is not to be displayed. |
| | |
| | The NOFILTER option can be overridden by |
| | entering the FILTER parameter as part of the |
| | primary command syntax. |
| | |
| | The subcommand FILTER can also be used to |
| | display the "filter" display screen. |
| | |
| | Syntax : OPTIONS NOFILTER |
| | |
+------------------+--------------------------------------------------+
| RESET | Request to option values to the defaults. |
| | |
| | Syntax : OPTIONS RESET |
| | |
+------------------+--------------------------------------------------+
Related Information

SYSVIEW Usage of MVS Log Streams

Security Requirements

For security requirements, use the link: AUDITLOG command security


AUDITMSG

AUDITMSG Command

The AUDITMSG command logs an audit event for type USER_EVENT_MESSAGE.


The content of the audit event is the text message entered with the
command.

Command Syntax

+---------------+-----------------------------------------------------+
| AUDITMSG | text |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| text | The audit event message content. |
| | The message text is case sensitive. |
+------------------+--------------------------------------------------+
AXATABLE

AXATABLE Command

The AXATABLE command displays information from the Authorization


Index Allocation Table.

Command Syntax

+---------------+------------------------------------------------------------+
| AXATABLE | |
+---------------+------------------------------------------------------------+

Parameters

This command has no parameters.

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| AX | The authorization index. |
+---------------+------------------------------------------------------------+
| Stat | The status of the authorization index. Valid values are: |
| | |
| | RES Reserved |
| | FREE Free |
+---------------+------------------------------------------------------------+
| ASID | The ASID to which the authorization index is allocated. |
+---------------+------------------------------------------------------------+
| Jobname | The jobname to which the authorization index is allocated. |
+---------------+------------------------------------------------------------+
| EAXC | The count of entry tables that use this authorization |
| | index as an extended authorization index. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. |
+---------------+------------------------------------------------------------+
BOOST

BOOST Command

The BOOST command displays information about the IBM Z System


Recovery Boost process.

What is System Recovery Boost?

System Recovery Boost provides capabilities to reduce the time it


takes to shutdown and restart your system by providing additional
processor capacity and throughput for a boosted image or LPAR.

How does System Recovery Boost work?

System Recovery Boost can deliver higher processor capacity for a


limited time during an IPL or system shutdown.

Two boost types are available for Z systems running on machines


with IBM z15 capabilities: zIIP Boost and Speed Boost.

Startup Boost during an IPL lasts for a maximum of 1 hour


and can be stopped by using the following operator command:

START IEABE

Shutdown Boost lasts for 30 minutes or until the system stops.

zIIP Boost System Requirements

* Has at least one online or standy zIIP


* Is not a dedicated partition
* Has HIPERDISPATCH set to YES

Speed Boost System Requirements

* Is running on a sub-capacity CPC

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| BOOST | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYSTEM | This forces cross-system data collection to be |
| XSDATA | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYSTEM | This forces cross-system data collection to be |
| NOXSDATA | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Boost | Identifies the type of boosts to activate: |
| | |
| | For either, you must be running on a z15 |
| | machine or higher. |
| | |
| | For a zIIP Boost, you must have HIPERDISPATCH |
| | set to YES and be on a non-dedicated partition. |
| | |
| | For a Speed Boost, you must be running on a |
| | sub-capacity processor. |
| | |
| | You specify the boost parameter in the |
| | IEASYSxx member using the "BOOST" keyword. |
| | |
| | Possible values are: |
| | |
| | SYSTEM - Activates whichever boosts the |
| | machine and environment can |
| | accommodate. |
| | |
| | ZIIP - Activates a zIIP Boost. |
| | Does not activate a Speed Boost. |
| | |
| | SPEED - Activates a Speed Boost. |
| | Does not activate a zIIP Boost. |
| | |
| | NONE - No boost is activated. |
| | |
| | DISPLAY IPLINFO,BOOST |
| | |
+------------------+--------------------------------------------------+
| Speed | Indicates the Speed Boost status. |
| | |
| | Possible values are: |
| | |
| | SPEED - A Speed Boost is currently active. |
| | |
| | blank - A Speed Boost is not currently |
| | active. |
| | |
+------------------+--------------------------------------------------+
| zIIP | Indicates the zIIP Boost status. |
| | |
| | Possible values are: |
| | |
| | ZIIP - A zIIP Boost is currently active. |
| | |
| | blank - A zIIP Boost is not currently |
| | active. |
| | |
+------------------+--------------------------------------------------+
| Cores | The number of transient cores configured online |
| | for a zIIP Boost. The cores are configured |
| | offline when the boost ends. |
+------------------+--------------------------------------------------+
| IPLDate | The date and time of the current IPL. |
| IPLTime | |
+------------------+--------------------------------------------------+
| IPL | Indicates if IPL Boosts were activated. |
| | |
| | Possible values are: |
| | |
| | IPL - IPL Boosts were activated. |
| | |
| | blank - IPL Boosts were not activated. |
| | |
+------------------+--------------------------------------------------+
| IPLEndRsn | The reason why the IPL Boosts ended. |
| | |
| | Possible values are: |
| | |
| | TIMER - Due to timer. |
| | |
| | PROGRAM - Due to the Boost end program. |
| | |
| | The "START IEABE" (IEA Boost End) |
| | command can be used to end Boost. |
| | |
| | SHUTDOWN - Due to a shutdown. |
| | |
| | ERROR - Due to an error. |
| | |
+------------------+--------------------------------------------------+
| Shutdown | Indicates if Shutdown Boosts were activated. |
| | |
| | Possible values are: |
| | |
| | SHUTDOWN - Shutdown Boosts were activated. |
| | |
| | blank - Shutdown Boosts were not activated.|
| | |
+------------------+--------------------------------------------------+
| ShutEndRsn | The reason why the Shutdown Boost ended. |
| | |
| | Possible values are: |
| | |
| | TIMER - Due to a timer. |
| | |
| | PROGRAM - Due to a program. |
| | |
| | ERROR - Due to an error. |
| | |
+------------------+--------------------------------------------------+
| EndDate | The expected date and time when boosts will end. |
| EndTime | Only valid if an IPL or Shutdown Boost was |
| | activated. The end date and time relate to |
| | the last activated boost. |
+------------------+--------------------------------------------------+
| CPSpeed | The speed of a general processor (CP) in |
| | relation to a specialty processor (SP). |
+------------------+--------------------------------------------------+
| HiperDispatch | Indicates the status of HiperDispatching. |
| | |
| | Possible values are: |
| | |
| | NONE - Not available. |
| | ENABLED - Enabled. |
| | DISABLED - Disabled. |
| | |
+------------------+--------------------------------------------------+
| CPUModel | The CPU model. |
+------------------+--------------------------------------------------+
| IPLSpeedErr | Indicates if an error ended the IPL Speed Boost. |
+------------------+--------------------------------------------------+
| IPLzIIPErr | Indicates if an error ended the IPL zIIP Boost. |
+------------------+--------------------------------------------------+
| ShutSpeedErr | Indicates if an error ended the Shutdown |
| | Speed Boost. |
+------------------+--------------------------------------------------+
| ShutzIIPErr | Indicates if an error ended the Shutdown |
| | zIIP Boost. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| SHUT | Issues the operator command "START IEASDBS" |
| | to start a Shutdown System Recovery Boost. |
+------------------+--------------------------------------------------+
| STOP | Issues the operator command "START IEABE" |
| | to stop the currently active System Recovery |
| | Boost. You can use this command to stop IPL |
| | or Shutdown Boosts. |
+------------------+--------------------------------------------------+
Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
BOTTOM

BOTTOM Command

The BOTTOM command scrolls the data rows to the bottom or end
of the data.

Command Syntax

+---------------+------------------------------------------------------------+
| BOTTOM | |
+---------------+------------------------------------------------------------+

Parameters

This command has no parameters.


BROWSE

BROWSE Command

The BROWSE command displays the specified data set.


The ISPF BROWSE facility is used. The BROWSE command
is only available when ISPF services are available.

Command Syntax

+---------------+------------------------------------------------------------+
| BROWSE | dsname[(member)][,volser] |
+---------------+------------------------------------------------------------+

Parameters

+----------------+-----------------------------------------------------------+
| Parameter | Explanation |
+----------------+-----------------------------------------------------------+
| dsname | The name of the data set you want to browse. Specify a |
| | fully qualified data set name by enclosing it in |
| | character delimiters. If you omit the character |
| | delimiters, then your data set name prefix is left |
| | appended to the data set name. For additional |
| | information on data set name prefixes, see the |
| | SET DSNAMEPREFIX command. |
+----------------+-----------------------------------------------------------+
| member | The name of the particular member you want to browse. If |
| | no member is supplied and the data set is a PDS, then |
| | ISPF displays the standard member selection screen. You |
| | must enclose the member name in parentheses and, if the |
| | data set name is fully qualified, the parentheses must be |
| | within the character delimiters. |
+----------------+-----------------------------------------------------------+
| volser | The volume serial number on which the data set resides. |
| | This parameter is required only if the data set is not |
| | cataloged. |
+----------------+-----------------------------------------------------------+
CACHECTL

CACHECTL Command

The CACHECTL command displays the status of cache control units.

Command Syntax

+---------------+------------------------------------------------------------+
| CACHECTL | [ssid] |
+---------------+------------------------------------------------------------+

Parameters

+----------------+-----------------------------------------------------------+
| Ssid value | Explanation |
+----------------+-----------------------------------------------------------+
| = | An equal sign entered as the subsystem identifier lists |
| | all subsystems. = is the default. |
+----------------+-----------------------------------------------------------+
| ssid | The storage subsystem identifier. Masking characters (* |
| | and =) can be used when entering a partial subsystem ID. |
+----------------+-----------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| SSid | The storage subsystem identifier. |
+---------------+------------------------------------------------------------+
| Ctl-Unit | The control unit model number. |
+---------------+------------------------------------------------------------+
| SSStg | The amount of subsystem storage that exists in the cache. |
+---------------+------------------------------------------------------------+
| SSAvl | The amount of storage that is available for caching. |
+---------------+------------------------------------------------------------+
| SSPin | The amount of storage that is unavailable because of |
| | cache-to-DASD exceptions. |
+---------------+------------------------------------------------------------+
| SSOff | The amount of storage that is offline because of a host |
| | or subsystem error. |
+---------------+------------------------------------------------------------+
| NVStg | The amount of nonvolatile storage that exists in the |
| | cache. |
+---------------+------------------------------------------------------------+
| NVPin | The amount of nonvolatile storage that is unavailable |
| | because of cache-to-DASD exceptions. |
+---------------+------------------------------------------------------------+
| Cache-Stat | The subsystem caching status. Valid values are: |
| | |
| | ACTIVE Subsystem storage is online |
| | ACTIV-PEND Cache is in the process of being brought |
| | online |
| | INACT-ERR An internal subsystem error occurred that |
| | caused termination of caching |
| | INACT-HOST Caching was deactivated as a result of |
| | an explicit host system or support |
| | facility request |
| | DEACT-PEND A command requesting deactivation has |
| | been received, and the destage is in |
| | progress |
| | DEACT-FAIL A command requesting deactivation has |
| | been received, but the destage failed |
+---------------+------------------------------------------------------------+
| NVS-Stat | The state of the nonvolatile storage. Valid values are: |
| | |
| | ACTIVE Nonvolatile storage is active |
| | INACT-ERR An internal subsystem error occurred |
| | that caused termination of nonvolatile |
| | storage |
| | INACT-HOST Nonvolatile storage was deactivated as a |
| | a result of an explicit host system or |
| | support facility request or as a result |
| | of a failure |
| | DEACT-PEND A command requesting deactivation has |
| | been received, and the destage is in |
| | progress |
| | DEACT-FAIL A command requesting deactivation has |
| | been received, but the destage failed |
| | DISABLED Nonvolatile storage is disabled for |
| | maintenance |
+---------------+------------------------------------------------------------+
| SD-Stat | The condition of the storage director receiving the sense |
| | subsystem status command. Valid values are: |
| | |
| | DISABLED Subsystem storage is disabled for |
| | maintenance |
| | DEV-UNAVL IML device unavailable |
| | ENABLED Subsystem storage is enabled |
+---------------+------------------------------------------------------------+
| CF-Write | The status of the cache fast write facility. Valid values |
| | are: |
| | |
| | ACTIVE Cache fast write is active |
| | DISABLED Cache fast write is disabled |
+---------------+------------------------------------------------------------+
| Volser | The volser of the device to which the I/O to the control |
| | unit was directed. |
+---------------+------------------------------------------------------------+
| Unit | The unit type of the device to which the I/O to the |
| | control unit was directed. |
+---------------+------------------------------------------------------------+
| Devn | The device number of the device to which the I/O to the |
| | control unit was directed. |
+---------------+------------------------------------------------------------+
| ErrCt | The number of errors that occurred attempting to obtain |
| | the data for this controller. If there is no error |
| | message in the Message field, then retry was successful. |
+---------------+------------------------------------------------------------+
| Message | A diagnostic error message. If any data appears in this |
| | field, contact Technical Support. |
+---------------+------------------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| CACHEON | Invokes IDCAMS to issue the following command to allow |
| | access to cache for the subsystem: |
| | |
| | SETCACHE VOL(volser) UNIT(unit) SUBSYSTEM ON |
+---------------+------------------------------------------------------------+
| CACHEOFF | Invokes IDCAMS to issue the following command to prohibit |
| | access to cache for the subsystem: |
| | |
| | SETCACHE VOL(volser) UNIT(unit) SUBSYSTEM OFF |
+---------------+------------------------------------------------------------+
| CFWON | Invokes IDCAMS to issue the following command to allow |
| | cache fast write for the subsystem: |
| | |
| | SETCACHE VOL(volser) UNIT(unit) CACHEFASTWRITE ON |
+---------------+------------------------------------------------------------+
| CFWOFF | Invokes IDCAMS to issue the following command to prohibit |
| | cache fast write for the subsystem: |
| | |
| | SETCACHE VOL(volser) UNIT(unit) CACHEFASTWRITE OFF |
+---------------+------------------------------------------------------------+
| NVSON | Invokes IDCAMS to issue the following command to allow |
| | access to the nonvolatile storage: |
| | |
| | SETCACHE VOL(volser) UNIT(unit) NVS ON |
+---------------+------------------------------------------------------------+
| NVSOFF | Invokes IDCAMS to issue the following command to prohibit |
| | access to the nonvolatile storage: |
| | |
| | SETCACHE VOL(volser) UNIT(unit) NVS OFF |
+---------------+------------------------------------------------------------+

Navigation Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| CDevice | Invokes the CACHEDEV command for the selected ssid. |
+---------------+------------------------------------------------------------+
| DUMp | Display the result of the Sense Subsystem Data CCW in |
| | dump format. |
+---------------+------------------------------------------------------------+
| LDCounts | Invokes the IDCAMS command to generate a subsystem counts |
| | report for the selected subsystem using a LISTDATA COUNTS |
| | command. |
+---------------+------------------------------------------------------------+
| LDDstats | Invokes the IDCAMS command to generate a device status |
| | report for the selected subsystem using a LISTDATA DSTATUS |
| | command. |
+---------------+------------------------------------------------------------+
| LDPinned | Invokes the IDCAMS command to generate a pinned track to |
| PINned | dataset cross reference report for the selected subsystem |
| | using a LISTDATA PINNED command. |
+---------------+------------------------------------------------------------+
| LDStatus | Invokes the IDCAMS command to generate a subsystem status |
| | report for the selected subsystem using a LISTDATA STATUS |
| | command. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. |
+---------------+------------------------------------------------------------+
| OPTIONS | Set and display CACHEDEV options. |
+---------------+------------------------------------------------------------+

OPTIONS Subcommand

The OPTIONS subcommand is used to set and display CACHECTL


command processing options.

OPTIONS Subcommand Format

+---------------+------------------------------------------------------------+
| OPTIONS | [cctlopts] |
+---------------+------------------------------------------------------------+

The following table lists and explains the valid OPTIONS


parameter values. Any number of the values can be specified
in any order. The current settings of all options are always
displayed in response to the OPTIONS subcommand.

+---------------+------------------------------------------------------------+
| Value | Explanation |
+---------------+------------------------------------------------------------+
| Cc | Controls the display of carriage control characters in the |
| NOCc | IDCAMS output produced by the line commands that invoke |
| | IDCAMS. The default is NOCC. |
+---------------+------------------------------------------------------------+
| Expand | Controls carriage control simulation in the IDCAMS output |
| NOExpand | produced by the line commands that invoke IDCAMS. The |
| | default is EXPAND. |
+---------------+------------------------------------------------------------+
| Legend | Controls whether a LEGEND or NOLEGEND keyword is used |
| NOLegend | on the LISTDATA commands submitted to IDCAMS by the |
| | LDC, LDD, LDP, and LDS line commands described above. |
| | The default is LEGEND. The IDCAMS LISTDATA command |
| | LEGEND/NOLEGEND keyword controls the display of the |
| | LEGEND section of the report produced by IDCAMS. |
+---------------+------------------------------------------------------------+
| Headers | Controls the display of header lines in the IDCAMS output |
| NOHeaders | produced by the line commands that invoke IDCAMS. The |
| | default is NOHEADERS. |
+---------------+------------------------------------------------------------+
| Output | Controls the display of the IDCAMS output produced by the |
| NOOutput | line commands that invoke IDCAMS issue SETCACHE commands. |
| | The default is NOOUTPUT. The output is always displayed |
| | regardless of the setting of this option if IDCAMS |
| | indicates that an error occurred in the execution of the |
| | SETCACHE command. |
+---------------+------------------------------------------------------------+
| Message | Controls whether or not IDCAMS messages will be displayed |
| NOMessage | using your message display attributes. The default is |
| | MESSAGE. |
+---------------+------------------------------------------------------------+
| EXTRact | Requests that the current option settings be extracted |
| | into a TSO CLIST or REXX EXEC variable. The variable |
| | created or updated is named SYSV_OPTIONS_CACHEDEV. |
| | This keyword is only valid when the product is running |
| | under a TSO CLIST or REXX EXEC. EXTRACT can be specified |
| | alone or in combination with any other OPTIONS keywords. |
+---------------+------------------------------------------------------------+

Messages

CACH001E Get cache data failed, rc [rtncd] rs [rsncd] ec [errcd]


abended, [abncd]

The get cache data service failed or abended with the indicated
codes. Contact technical support.

CACH002W No cache control units found

Self-explanatory.

CACH003W No supported cache control units found

Self-explanatory. Currently supported cache control units are


models 3990-3 and 3990-6.

CACH004E [linecmd] command failed - IDCAMS failed, rc [rtncd]


abended [abncd]

The line command [linecmd] invoked IDCAMS to execute a SETCACHE


command and IDCAMS failed or abended with the indicated return
code or abend code.

CACH005E [linecmd] invalid from [intfc] interface at [pgm] [lvl] or higher

Informational only.
CACHEDEV

CACHEDEV Command

The CACHEDEV command displays the status of DASD devices


attached to cache control units.

Command Syntax

+---------------+------------------------------------------------------------+
| CACHEDEV | [ssid][volser] |
+---------------+------------------------------------------------------------+

Parameters

+----------------+-----------------------------------------------------------+
| Parameter | Explanation |
+----------------+-----------------------------------------------------------+
| ssid | The storage subsystem identifier. Masking characters (* |
| | and =) can be used when entering a partial subsystem ID. |
+----------------+-----------------------------------------------------------+
| volser | A specific or generic volser. Masking characters (* and |
| | =) are used when entering a generic volser. |
+----------------+-----------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| SSid | The storage subsystem identifier. |
+---------------+------------------------------------------------------------+
| Volser | The volume serial number. |
+---------------+------------------------------------------------------------+
| Unit | The unit type. |
+---------------+------------------------------------------------------------+
| Devn | The device number. |
+---------------+------------------------------------------------------------+
| Cache | The device caching state. Valid values are: |
| | |
| | YES Caching activated |
| | PEND Deactivation pending. Transfer of modified |
| | data to DASD failed. |
| | NO Caching deactivated |
+---------------+------------------------------------------------------------+
| DFWrt | The DASD fast write state. Valid values are: |
| | |
| | YES DASD fast write is allowed |
| | PEND Deactivation pending. Transfer of modified |
| | data to DASD failed. |
| | NO DASD fast write disabled |
+---------------+------------------------------------------------------------+
| Pin | The pinned data indicator. Valid values are: |
| | |
| | FWS One or more tracks for this volume are pinned |
| | and both cache fast write and DASD fast write |
| | are suspended for this volume |
| | NO No tracks for this volume are pinned |
| | YES Pinned data exists, but fast write has not |
| | been suspended for this volume |
+---------------+------------------------------------------------------------+
| Nvs | Data in failed the nonvolatile storage indicator. Valid |
| | values are: |
| | |
| | YES Data for this volume is in the nonvolatile |
| | storage that is in the failed state |
| | NO No data for this volume is in the failed |
| | nonvolatile storage or the nonvolatile storage |
| | is not failed |
+---------------+------------------------------------------------------------+
| RdCnt | The total of all search or read operations. |
+---------------+------------------------------------------------------------+
| RdHit | The percentage of all search or read operation that did |
| | not require data movement to or from DASD. |
+---------------+------------------------------------------------------------+
| RdHitGraph | A graphic display of the RdHit field described above. |
+---------------+------------------------------------------------------------+
| WrCnt | The total of all write operations. |
+---------------+------------------------------------------------------------+
| WrHit | The percentage of all cache fast write or DASD fast write |
| | operations that did not require concurrent data movement |
| | to or from DASD. |
+---------------+------------------------------------------------------------+
| WrHitGraph | A graphic display of the WrHit field described above. |
+---------------+------------------------------------------------------------+
| DFWCt | The percentage of all write operations that are addressed |
| | to a device in DASD fast write mode and that do not |
| | contain a define extent command or that do not inhibit |
| | DASD fast write in a define extent command. |
+---------------+------------------------------------------------------------+
| DFWCtGraph | A graphic display of the DFWCt field described above. |
+---------------+------------------------------------------------------------+
| CDTrk | The total number of tracks transferred from cache to DASD. |
+---------------+------------------------------------------------------------+
| DCTrk | The total number of tracks transferred from DASD to cache. |
+---------------+------------------------------------------------------------+
| Inhib | The count of operations that specify the inhibit cache |
| | loading attribute in the define extent command and contain |
| | at least one search, read, or write command. |
+---------------+------------------------------------------------------------+
| Bypas | The count of operations specifying the bypass cache |
| | attribute in the define extent command and containing at |
| | least one search, read, or write command. |
+---------------+------------------------------------------------------------+
| Retry | The count of retries required before space was available |
| | in the nonvolatile storage for DASD fast write data. |
+---------------+------------------------------------------------------------+
| Did | The device identifier. |
+---------------+------------------------------------------------------------+
| Duplx | The simplex/duplex status of the device and the state of |
| | the pair when duplex. Valid values are: |
| | |
| | SIM Device is simplex |
| | PRI Device is primary device of a duplex pair |
| | SEC Device is secondary device of a duplex pair |
| | |
| | The following values can be appended to the above: |
| | |
| | -P Copy to establish a duplex pair is pending or |
| | in progress |
| | -S Duplex pair suspended by host command or by |
| | subsystem |
+---------------+------------------------------------------------------------+
| Oid | The other device ID of the duplex pair. |
+---------------+------------------------------------------------------------+
| Message | A diagnostic error message. If any data appears in this |
| | field, contact Technical Support. |
+---------------+------------------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| CACHEOFF | Invokes IDCAMS to issue the following command to prohibit |
| | access to cache for the device: |
| | |
| | SETCACHE VOL(volser) UNIT(unit) DEVICE OFF |
+---------------+------------------------------------------------------------+
| CACHEON | Invokes IDCAMS to issue the following command to allow |
| | access to cache for the device: |
| | |
| | SETCACHE VOL(volser) UNIT(unit) DEVICE ON |
+---------------+------------------------------------------------------------+
| DFWOFF | Invokes IDCAMS to issue the following command to prohibit |
| | DASD fast write for the device: |
| | |
| | SETCACHE VOL(volser) UNIT(unit) DASDFASTWRITE OFF |
+---------------+------------------------------------------------------------+
| DFWON | Invokes IDCAMS to issue the following command to allow |
| | DASD fast write for the device: |
| | |
| | SETCACHE VOL(volser) UNIT(unit) DASDFASTWRITE ON |
+---------------+------------------------------------------------------------+
| Zap | Invokes the ZAP command for the selected volser. |
+---------------+------------------------------------------------------------+
| ZRO | Invokes the ZAP command with the READONLY option for the |
| | selected volser. |
+---------------+------------------------------------------------------------+
| ZRW | Invokes the ZAP command with the READWRITE option for the |
| | selected volser. |
+---------------+------------------------------------------------------------+

Navigation Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Allocas | Invokes the ALLOCAS command for the selected device |
| | number. |
+---------------+------------------------------------------------------------+
| CCtl | Invokes the CACHECTL command for the selected ssid. |
| CACHECtl | Invokes the CACHECTL command for the selected ssid. |
+---------------+------------------------------------------------------------+
| CONnect | Plot device connect times for the selected ssid. |
+---------------+------------------------------------------------------------+
| CQuery | Invokes the CQUERY command to query the PPRC status for |
| | the selected device. Available from the TSO/ISPF |
| | interface only. |
+---------------+------------------------------------------------------------+
| CQPaths | Invokes the CQUERY PATHS command to query the PPRC status |
| | the selected device path. Available from the TSO/ISPF |
| | interface only. |
+---------------+------------------------------------------------------------+
| DISconn | Plot device disconnect time for the selected ssid. |
+---------------+------------------------------------------------------------+
| DSinfo | Invokes a DSINFO VTOC command to display information |
| Info | about the volume serial number. |
+---------------+------------------------------------------------------------+
| DUMp | Display the result of the Read Subsystem Statistics Data |
| | CCW in dump format. |
+---------------+------------------------------------------------------------+
| EXtents | Invokes the EXTENTS command for the selected volser. |
| Xtents | |
| Xtns | |
+---------------+------------------------------------------------------------+
| FCQuery | Invokes the FCQUERY command to query the Copy Services for |
| | the selected device (XRC, PPRC, Concurrent Copy, or |
| | FlashCopy). Available from the TSO/ISPF interface only. |
+---------------+------------------------------------------------------------+
| IO | Plot SSCH instruction count for the selected ssid. |
| USE | |
+---------------+------------------------------------------------------------+
| LDCounts | Invokes the IDCAMS command to generate a subsystem counts |
| | report for the selected subsystem using a LISTDATA COUNTS |
| | command. |
+---------------+------------------------------------------------------------+
| LDDstats | Invokes the IDCAMS command to generate a device status |
| | report for the selected subsystem using a LISTDATA DSTATUS |
| | command. |
+---------------+------------------------------------------------------------+
| LDPinned | Invokes the IDCAMS command to generate a pinned track to |
| PINned | dataset cross reference report for the selected subsystem |
| | using a LISTDATA PINNED command. |
+---------------+------------------------------------------------------------+
| LDStatus | Invokes the IDCAMS command to generate a subsystem status |
| | report for the selected subsystem using a LISTDATA STATUS |
| | command. |
+---------------+------------------------------------------------------------+
| PENding | Plot device pending time for the selected ssid. |
+---------------+------------------------------------------------------------+
| PLot | Invokes a PLOTLIST DEVICE command to display a plot |
| | selection list for the selected volume. |
+---------------+------------------------------------------------------------+
| SERvice | Plot device service time for the selected ssid. |
+---------------+------------------------------------------------------------+
| SPace | Invokes the SPACE command for the selected volser. |
| SPc | |
+---------------+------------------------------------------------------------+
| Vtoc | Invokes VTOC command for the selected volser. |
| Vtc | |
+---------------+------------------------------------------------------------+
| VCc | Invokes VTOC command for the volser with the CHKCAT |
| | keyword. |
+---------------+------------------------------------------------------------+
| XCc | Invokes EXTENTS command for the volser with the CHKCAT |
| | keyword. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. |
+---------------+------------------------------------------------------------+
| OPTIONS | Set and display CACHECTL options. |
+---------------+------------------------------------------------------------+

OPTIONS Subcommand

The OPTIONS subcommand is used to set and display CACHEDEV


command processing options.

OPTIONS Subcommand Format

+---------------+------------------------------------------------------------+
| OPTIONS | [cdevopts] |
+---------------+------------------------------------------------------------+

The following table lists and explains the valid OPTIONS


parameter values. Any number of the values can be specified
in any order. The current settings of all options are always
displayed in response to the OPTIONS subcommand.

+---------------+------------------------------------------------------------+
| Value | Explanation |
+---------------+------------------------------------------------------------+
| Cc | Controls the display of carriage control characters in the |
| NOCc | IDCAMS output produced by the line commands that invoke |
| | IDCAMS. The default is NOCC. |
+---------------+------------------------------------------------------------+
| Expand | Controls carriage control simulation in the IDCAMS output |
| NOExpand | produced by the line commands that invoke IDCAMS. The |
| | default is EXPAND. |
+---------------+------------------------------------------------------------+
| Legend | Controls whether a LEGEND or NOLEGEND keyword is used |
| NOLegend | on the LISTDATA commands submitted to IDCAMS by the |
| | LDC, LDD, LDP, and LDS line commands described above. |
| | The default is LEGEND. The IDCAMS LISTDATA command |
| | LEGEND/NOLEGEND keyword controls the display of the |
| | LEGEND section of the report produced by IDCAMS. |
+---------------+------------------------------------------------------------+
| Headers | Controls the display of header lines in the IDCAMS output |
| NOHeaders | produced by the line commands that invoke IDCAMS. The |
| | default is NOHEADERS. |
+---------------+------------------------------------------------------------+
| Output | Controls the display of the IDCAMS output produced by the |
| NOOutput | line commands that invoke IDCAMS issue SETCACHE commands. |
| | The default is NOOUTPUT. The output is always displayed |
| | regardless of the setting of this option if IDCAMS |
| | indicates that an error occurred in the execution of the |
| | SETCACHE command. |
+---------------+------------------------------------------------------------+
| Message | Controls whether or not IDCAMS messages will be displayed |
| NOMessage | using your message display attributes. The default is |
| | MESSAGE. |
+---------------+------------------------------------------------------------+
| EXTRact | Requests that the current option settings be extracted |
| | into a TSO CLIST or REXX EXEC variable. The variable |
| | created or updated is named SYSV_OPTIONS_CACHEDEV. |
| | This keyword is only valid when the product is running |
| | under a TSO CLIST or REXX EXEC. EXTRACT can be specified |
| | alone in combination with any other OPTIONS keywords. |
+---------------+------------------------------------------------------------+

Messages

CACH001E Get cache data failed, rc [rtncd] rs [rsncd] ec [errcd]


abended, [abncd]

The get cache data service failed or abended with the indicated
codes. Contact technical support.

CACH002W No cache control units found

Self-explanatory.

CACH003W No supported cache control units found

Self-explanatory. Currently supported cache control units are


models 3990-3 and 3990-6.

CACH004E [linecmd] command failed - IDCAMS failed, rc [rtncd]


abended [abncd]

The line command [linecmd] invoked IDCAMS to execute a SETCACHE


command and IDCAMS failed or abended with the indicated return
code or abend code.

CACH005E [linecmd] invalid from [intfc] interface at [pgm] [lvl] or higher

Informational only.
CADCONS

CADCONS Command

The CADCONS command displays information for CCS data consumers.

Command Syntax

+------------------+--------------------------------------------------+
| CADCONS | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,JobID,ConnName,A,


PathName,A,SelectName,A,Category,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Jobname |
+------------------+--------------------------------------------------+
| Writes | Total writes |
+------------------+--------------------------------------------------+
| BytesWritten | Total bytes written |
+------------------+--------------------------------------------------+
| RecvMsgs | Message requests received |
+------------------+--------------------------------------------------+
| RespSent | Responses sent |
+------------------+--------------------------------------------------+
| PathName | Owner path name |
+------------------+--------------------------------------------------+
| State | Current state |
+------------------+--------------------------------------------------+
| XmitSent | Number of data items transmitted |
+------------------+--------------------------------------------------+
| XmitBytes | Number of bytes transmitted |
+------------------+--------------------------------------------------+
| Pending | Pending or queued writes |
+------------------+--------------------------------------------------+
| BytesPend | Pending bytes to be written |
+------------------+--------------------------------------------------+
| Rejected | Rejected write requests |
+------------------+--------------------------------------------------+
| BytesReject | Total bytes rejected |
+------------------+--------------------------------------------------+
| QLimit | Limit of objects to be queued |
+------------------+--------------------------------------------------+
| QBytesLimit | Limit of bytes to be queued |
+------------------+--------------------------------------------------+
| SelectionName | Selection name |
+------------------+--------------------------------------------------+
| Category | Category name |
+------------------+--------------------------------------------------+
| ItemsMatched | Number of data items matched |
+------------------+--------------------------------------------------+
| ConnDate | Connect date |
+------------------+--------------------------------------------------+
| ConnTime | Connect time |
+------------------+--------------------------------------------------+
| DiscDate | Disconnect date |
+------------------+--------------------------------------------------+
| DiscTime | Disconnect time |
+------------------+--------------------------------------------------+
| LastDate | Last operation date |
+------------------+--------------------------------------------------+
| LastTime | Last operation time |
+------------------+--------------------------------------------------+
| XmitDate | Last xmit date |
+------------------+--------------------------------------------------+
| XmitTime | Last xmit time |
+------------------+--------------------------------------------------+
| ConnectionName | Name of message service adapter |
+------------------+--------------------------------------------------+
| JobID | JobID |
+------------------+--------------------------------------------------+
| USERID | Userid assigned to jobname |
+------------------+--------------------------------------------------+
| ASID | ASID of jobname |
+------------------+--------------------------------------------------+
| ASCB | Address of the ASCB control block |
+------------------+--------------------------------------------------+
| STOKEN | STOKEN |
+------------------+--------------------------------------------------+
| TTOKEN | TTOKEN |
+------------------+--------------------------------------------------+
| GID | USS group ID |
+------------------+--------------------------------------------------+
| UID | USS user ID |
+------------------+--------------------------------------------------+
| PID | USS process ID |
+------------------+--------------------------------------------------+
| MsgQID | Response message Q ID |
+------------------+--------------------------------------------------+
| MsgToken | Message token |
+------------------+--------------------------------------------------+
| Destination | Destination name |
+------------------+--------------------------------------------------+
| PipeName | Pipe name |
+------------------+--------------------------------------------------+
| DState | Desired state |
+------------------+--------------------------------------------------+
| Owner | Product owner |
+------------------+--------------------------------------------------+
| Product | Product name |
+------------------+--------------------------------------------------+
| Component | Product component |
+------------------+--------------------------------------------------+
| Instance | Product instance |
+------------------+--------------------------------------------------+
| Release | Product release |
+------------------+--------------------------------------------------+
| Type | Entry type |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| LISTFile | Invokes the LISTFILE command for the selected |
| LF | jobname. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
CADMOVER

CADMOVER Command

The CADMOVER command displays information for the CCS Data Mover.

Command Syntax

+------------------+--------------------------------------------------+
| CADMOVER | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Status,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | CCS DataMover jobname |
+------------------+--------------------------------------------------+
| Status | Status of the data mover |
| | Possible value are: |
| | ACTIVE - The data mover is active. |
| | INACTIVE - The data mover is inactive. |
| | NONE - The data mover has not been |
| | initialized. |
+------------------+--------------------------------------------------+
| StartDate | Start date |
+------------------+--------------------------------------------------+
| StartTime | Start time |
+------------------+--------------------------------------------------+
| StopDate | Stop date |
+------------------+--------------------------------------------------+
| StopTime | Stop time |
+------------------+--------------------------------------------------+
| MsgQDate | Date MsgQ was created |
+------------------+--------------------------------------------------+
| MsgQTime | Time MsgQ was created |
+------------------+--------------------------------------------------+
| MsgQKey | Key used for MsgQ |
+------------------+--------------------------------------------------+
| MsgQID | MsgQ ID for Data Mover requests |
+------------------+--------------------------------------------------+
| MaxMsgQL | Maximum length of MsgQ request or response |
+------------------+--------------------------------------------------+
| MaxDataL | Maximum length of data object |
+------------------+--------------------------------------------------+
| TTOKEN | TTOKEN |
+------------------+--------------------------------------------------+
XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
CADPROD

CADPROD Command

The CADPROD command displays information for CCS data producers.

Command Syntax

+------------------+--------------------------------------------------+
| CADPROD | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Owner,A,Product,A,Component,A


Instance,A,Release,A,Category,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Owner | Product owner |
+------------------+--------------------------------------------------+
| Product | Product name |
+------------------+--------------------------------------------------+
| Component | Product component |
+------------------+--------------------------------------------------+
| Category | Category name |
+------------------+--------------------------------------------------+
| Consumers | Number of consumers |
+------------------+--------------------------------------------------+
| Writes | Total writes |
+------------------+--------------------------------------------------+
| BytesWritten | Total bytes written |
+------------------+--------------------------------------------------+
| BytesBuffer | Accumulated buffered bytes |
+------------------+--------------------------------------------------+
| Instance | Product instance name |
+------------------+--------------------------------------------------+
| Release | Product release |
+------------------+--------------------------------------------------+
| Pending | Pending or queued writes |
+------------------+--------------------------------------------------+
| BytesPend | Pending bytes to be written |
+------------------+--------------------------------------------------+
| Rejected | Rejected write requests |
+------------------+--------------------------------------------------+
| BytesRejected | Total bytes rejected |
+------------------+--------------------------------------------------+
| QLimit | Limit of objects to be queued |
+------------------+--------------------------------------------------+
| QBytesLimit | Limit of bytes to be queued |
+------------------+--------------------------------------------------+
| Type | Entry type |
+------------------+--------------------------------------------------+
| InUse | Indicates if the connection is currently in use. |
+------------------+--------------------------------------------------+
| Persist | Indicates the connection is persistent. |
+------------------+--------------------------------------------------+
| Internal | Indicates the connection is internal. |
+------------------+--------------------------------------------------+
| EvntExit | Event exit |
+------------------+--------------------------------------------------+
| EvntMode | Event mode |
+------------------+--------------------------------------------------+
| SUP | SUPERVISOR state |
+------------------+--------------------------------------------------+
| APF | APF authorized |
+------------------+--------------------------------------------------+
| Key | PSW key |
+------------------+--------------------------------------------------+
| UserData | User data |
+------------------+--------------------------------------------------+
| CCSID | Code character set ID |
+------------------+--------------------------------------------------+
| Jobname | Jobname |
+------------------+--------------------------------------------------+
| JobID | JobID |
+------------------+--------------------------------------------------+
| ASID | ASID of jobname |
+------------------+--------------------------------------------------+
| ASCB | Address of the ASCB control block |
+------------------+--------------------------------------------------+
| TCB | Address of the TCB control block |
+------------------+--------------------------------------------------+
| STOKEN | STOKEN |
+------------------+--------------------------------------------------+
| TTOKEN | TTOKEN |
+------------------+--------------------------------------------------+
| ConnDate | Connect date |
+------------------+--------------------------------------------------+
| ConnTime | Connect time |
+------------------+--------------------------------------------------+
| DiscDate | Disconnect date |
+------------------+--------------------------------------------------+
| DiscTime | Disconnect time |
+------------------+--------------------------------------------------+
| LastDate | Last operation date |
+------------------+--------------------------------------------------+
| LastTime | Last operation time |
+------------------+--------------------------------------------------+
| ChgDate | Consumer ON/OFF date |
+------------------+--------------------------------------------------+
| ChgTime | Consumer ON/OFF time |
+------------------+--------------------------------------------------+
| ConnectToken | Connection token |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DISC | Disconnect the data producer connection |
| | |
| | Warning: This should only be done at the |
| | direction of Technical Support. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
CAICCI

CAICCI Command

Common Services for z/OS provides a communications service called


CCI. This command displays a list of receivers participating in
this service.

Command Syntax

+------------------+--------------------------------------------------+
| CAICCI | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Sysplex | The CCI sysplex id of the receiver. Blanks |
| | are displayed if the receiver's sysid is not |
| | defined as part of a CCI sysplex. |
+------------------+--------------------------------------------------+
| RSysId | The receiver system identifier. This is a |
| | portion of the complete receiver identifier. |
+------------------+--------------------------------------------------+
| ReceiverId | The receiver identifier. This is a portion of |
| | the complete receiver identifier. |
+------------------+--------------------------------------------------+
| Type | The type. Valid values are: |
| | |
| | LOCAL Local to this host |
| | REMOTE Remote to this host |
+------------------+--------------------------------------------------+
| RJobname | The receiver jobname. |
+------------------+--------------------------------------------------+
| RJobId | The receiver jobid. |
+------------------+--------------------------------------------------+
| Status | The current status of this receiver. Valid |
| | values are: |
| | |
| | ACTIVE |
| | INACTIVE |
+------------------+--------------------------------------------------+
| Queued | The number of messages queued to the receiver. |
+------------------+--------------------------------------------------+
| Sends | The number of sends to the receiver. |
+------------------+--------------------------------------------------+
| Receives | The number of receives by the receiver. |
+------------------+--------------------------------------------------+
| Recycle | The receiver recycle count. |
+------------------+--------------------------------------------------+
| ROrigin | The receiver origin. |
+------------------+--------------------------------------------------+
| SSysId | The sender system identifier. This is a portion |
| | of the complete sender identifier. |
+------------------+--------------------------------------------------+
| SenderId | The sender identifier. This is a portion of the |
| | complete sender identifier. |
+------------------+--------------------------------------------------+
| Lvl | The release level. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
CAIDS

CAIDS Command

The CAIDS command displays the CICS Automatic Initiate Descriptors


(AID) chain.

An AID exists because a terminal was unavailable to a transaction


when the ICE expires or when an intrapartition data set reaches the
trigger level. This may be due to another transaction actively using
the requested terminal, or the terminal may be out of service.

Command Syntax

+------------------+--------------------------------------------------+
| CAIDS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Tran | The transaction name to be started when the |
| | associated terminal becomes available. |
+------------------+--------------------------------------------------+
| Term | The terminal ID on which the transaction is |
| | started. |
+------------------+--------------------------------------------------+
| TCTTE | The address of the TCTTE control block |
| | associated with the AID. |
+------------------+--------------------------------------------------+
| Address | The address of the AID control block. |
+------------------+--------------------------------------------------+
| Id | The unique ID given to the AID by the |
| | application program or CICS. The ID is |
| | displayed as an * when the internal ID is equal |
| | to nulls. |
+------------------+--------------------------------------------------+
| Type | The method used to initiate the transaction. |
| | Valid values are: |
| | |
| | X'80' BMS - schedule request |
| | X'50' PUT - start with data |
| | X'40' INT - start without data |
| | X'10' TDP - schedule request |
| | X'08' ISC - allocate request |
| | X'04' REMDEL - remote delete |
+------------------+--------------------------------------------------+
| Status | The current status bytes for the AID. This |
| | field displays, in hexadecimal format, the AID |
| | type and status. The first two digits indicate |
| | the AID type. Valid values are: |
| | |
| | X'80' AID is for privileged allocate |
| | X'40' Sent to TOR |
| | X'20' Cancel remote AID |
| | X'10' AID not yet routed to AOR |
| | X'08' Prevent duplicate send to TOR |
| | X'04' AID for a remote transaction |
| | X'02' AID for a remote terminal |
| | X'01' Task initiated |
+------------------+--------------------------------------------------+
| Dest | The destination of the transaction when started. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Purge | Purge the AIDs associated with the terminal. |
+------------------+--------------------------------------------------+
| Terms | Invokes the CTERMS command selecting the current |
| | terminal ID. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

Problem Determination

An AID exists because a terminal was unavailable to a transaction


when the ICE expires or when an intrapartition data set reaches the
trigger level. This may be due to another transaction actively using
the requested terminal, or the terminal may be out of service.

Transactions can be automatically started by one of two methods:

(1) A time dependent event causes the transaction to be started.


(2) An intrapartition transient data set triggers the transaction.

CICS checks if a terminal is required by the transaction. If not, then


then transaction begins to execute. If a terminal is required, then CICS
checks to see if the terminal is available and in service. If a terminal
is available and in service, then CICS acquires the terminal and the
transaction begins to execute. If the terminal is out of service or in
use, then CICS creates an AID to keep track of the request for later use.

When a terminal becomes available, CICS starts the transaction


and removes the AID from the system. If the requested terminal never
becomes available, then the AID stays on the chain.

By displaying the AID chain, you can identify potential problems


in the CICS region. For example, if entries continue to stay on the
list or if the list continues to grow, then you may have several
out-of-service terminals. Other typical problems are paper jams,
empty forms, power failures, and phone line problems.

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CAIDS command security


CAILMP

CAILMP Command

The CAILMP command is used to display Common Components and Services


(CCS) LMP code exceptions and violation information.

Command Syntax

+------------------+--------------------------------------------------+
| CAILMP | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Violations | The number of LMP calls resulting in a |
| | violation. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Code | The LMP code. |
+------------------+--------------------------------------------------+
| Product | The product description that is associated with |
| | the LMP code. |
| | |
| | The product description can be found in the |
| | parameter library member LMPCODES. |
| | |
| | New codes can be added to the LMPCODES |
| | parmlib member. Edit View |
+------------------+--------------------------------------------------+
| Violations | The number of violations. |
+------------------+--------------------------------------------------+
| DaysLeft | The number of days left until expiration. |
| | If negative, the number of days past expiration. |
+------------------+--------------------------------------------------+
| Status | Status indicator. |
| | |
| | Possible values are: |
| | AUTH - Authorized |
| | VIOLATE - Violations have occurred. |
| | WARNING - Current date is beyond the |
| | warning expiration date. |
| | EXPIRED - Current date is beyond the |
| | expiration date. |
+------------------+--------------------------------------------------+
| Warning | The product warning expiration date. |
+------------------+--------------------------------------------------+
| Expire | The product expiration date. |
+------------------+--------------------------------------------------+
| LastDate | The date of the last violation. |
+------------------+--------------------------------------------------+
| LastTime | The time of the last violation. |
+------------------+--------------------------------------------------+
| InitDate | The date of the initial violation. |
+------------------+--------------------------------------------------+
| InitTime | The time of the initial violation. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

The list of LMP Product Codes can also be found at:


http://support.broadcom.com
CAIRIM

CAIRIM Command

The CAIRIM command is used to display information about products


that have been installed by the Common Services for z/OS
Resource Initialization Manager.

Command Syntax

+------------------+--------------------------------------------------+
| CAIRIM | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Product | The product name. |
+------------------+--------------------------------------------------+
| Vers | The product version. |
+------------------+--------------------------------------------------+
| Routine | The initialization routine name. |
+------------------+--------------------------------------------------+
| Parameters | The optional parameters for the initialization |
| | routine. |
+------------------+--------------------------------------------------+
| REINIT | Specifies that the product supports REINIT. |
+------------------+--------------------------------------------------+
| SVC1 | The SVC number in use by the product. |
| SVC2 | |
| SVC3 | |
+------------------+--------------------------------------------------+
| Data | Product user data. |
+------------------+--------------------------------------------------+
| Date | The date of initialization. |
+------------------+--------------------------------------------------+
| Time | The time of initialization. |
+------------------+--------------------------------------------------+
| DatasetName | The LOADLIB data set name for solution or |
| | service load modules. If the modules are in |
| | linklist or the CAIRIM procedure STEPLIB, then |
| | the data set name can be blank. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.
Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
CAISMF

CAISMF Command

The CAISMF command is used to display information about the SMF


intercepts that have been installed by Common Services for z/OS.

Command Syntax

+------------------+--------------------------------------------------+
| CAISMF | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Calls processed | The number of SMF calls that have been |
| | processed. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Name | The SMF exit name. |
+------------------+--------------------------------------------------+
| Address | The address of the exit routine. |
+------------------+--------------------------------------------------+
| Vers | The version. |
+------------------+--------------------------------------------------+
| Description | An exit description. |
+------------------+--------------------------------------------------+
| Type | The SMF exit type. |
+------------------+--------------------------------------------------+
| ENABLED | The entry is enabled. |
+------------------+--------------------------------------------------+
| ABENDED | The entry has abended. |
+------------------+--------------------------------------------------+
| TEST | Call the test program on the first call. |
+------------------+--------------------------------------------------+
| DISABEND | Disable the entry on abend. |
+------------------+--------------------------------------------------+
| SVCDUMP | Take an SVC dump on abend. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands


CALC

CALC Command

The CALC command calculates the result of a supplied expression


and displays it in a message.

Command Syntax

+------------------+--------------------------------------------------+
| CALC | expression [OPTIONS optlist] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| expression | The right half of any valid REXX arithmetic |
| | assignment expression. |
+------------------+--------------------------------------------------+
| OPTIONS | A keyword that separates the expression that |
| | precedes it and the options that follow it. |
| | The OPTIONS keyword can be truncated down to O. |
+------------------+--------------------------------------------------+
| optlist | A list of option keywords. Any number of values |
| | can be specified in any order. Valid option |
| | keywords are: |
| | |
| | DIGITS number Controls the precision to |
| | which arithmetic operations |
| | and built-in functions are |
| | evaluated. The value must |
| | be a positive whole number. |
| | The default is 32. The |
| | DIGITS keyword can be |
| | truncated to D. |
| | |
| | SCIENTIFIC Requests that when the |
| | result is in exponential |
| | form only one nonzero digit |
| | will appear before the |
| | decimal point. This keyword |
| | can be truncated to S. |
| | SCIENTIFIC is the default |
| | between SCIENTIFIC and |
| | ENGINEERING. |
| | |
| | ENGINEERING Requests that when the |
| | result is in exponential |
| | form the power of 10 will |
| | always be a multiple of 3. |
| | This keyword can be |
| | truncated to E. |
| | |
+------------------+--------------------------------------------------+
Messages

CALC001I [expression] = [result]

This message displays the supplied expression and


the result. This message is used when the result
is numeric.

CALC002W No expression specified

The required expression was not supplied.

CALC003E Don't specify an equal sign

The expression supplied contained an equal sign.


Do not specify an equal sign - just the right half
of any valid REXX assignment statement.

CALC004E Host command error [rc] - [errtext]

A host command error occurred. [rc] is the error


number and [errtext] is the error text.

CALC005E External interrupt attempted

An external interrupt was attempted. Processing


aborted.

CALC006E Uninitialized variable in expression

The supplied expression contained an uninitialized


variable.

CALC007E REXX syntax error [rc] in line [line] - [errtext]

REXX syntax error number [rc] occurred in line [line].


[errtext] is the error text associated with the error
number.

CALC010E [opt] keyword requires a value

The [opt] keyword requires a value but none was


specified.

CALC011E [opt] keyword value must be a number from 4 to 200

The [opt] keyword value supplied was not valid. It


must be a number from 4 to 200.

CALC013E Unrecognized option: [erropt]

An option was specified that was not recognized.

CALC013I [exrpression] = [result]

This message displays the supplied expression and


the result. This message is used when the result
is not numeric.
CALENDAR

CALENDAR Command

The Calendar command can display a monthly calendar for any month
between January 0000 and December 9999. By default, a 12 month
calendar for the current year is displayed.

Command Syntax

+------------------+--------------------------------------------------+
| CALENDAR | [ year month count ] |
| | [ * * ] |
| | [ +nnn +nnn ] |
| | [ -nnn -nnn ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| year | The desired calendar year. "*" indicates the |
| | current year. If a "+nnn" or "-nnn" value is |
| | entered, then the year is computed based on |
| | today's year. |
| | |
| | Default = current year |
| | Minimum = 0000 |
| | Maximum = 9999 |
+------------------+--------------------------------------------------+
| month | The desired starting month. "*" indicates the |
| | current month. If a "+nnn" or "-nnn" value is |
| | entered, then the month is computed based on |
| | today's month. The year could also be affected. |
| | |
| | Default = 01 |
| | Minimum = 01 |
| | Maximum = 12 |
+------------------+--------------------------------------------------+
| count | The number of months to be displayed. |
| | |
| | Default = 12 |
| | Minimum = 01 |
| | Maximum = 9999 |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Today is | Today's date. |
| | Format: dayofweek month day,year |
+------------------+--------------------------------------------------+
| Julian | Today's julian date. |
| | Format: yyyy/ddd |
+------------------+--------------------------------------------------+
Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

Perpetual Julian Date Calendar

Day Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec Day
1 001 032 060 091 121 152 182 213 244 274 305 335 1
2 002 033 061 092 122 153 183 214 245 275 306 336 2
3 003 034 062 093 123 154 184 215 246 276 307 337 3
4 004 035 063 094 124 155 185 216 247 277 308 338 4
5 005 036 064 095 125 156 186 217 248 278 309 339 5
6 006 037 065 096 126 157 187 218 249 279 310 340 6
7 007 038 066 097 127 158 188 219 250 280 311 341 7
8 008 039 067 098 128 159 189 220 251 281 312 342 8
9 009 040 068 099 129 160 190 221 252 282 313 343 9
10 010 041 069 100 130 161 191 222 253 283 314 344 10
11 011 042 070 101 131 162 192 223 254 284 315 345 11
12 012 043 071 102 132 163 193 224 255 285 316 346 12
13 013 044 072 103 133 164 194 225 256 286 317 347 13
14 014 045 073 104 134 165 195 226 257 287 318 348 14
15 015 046 074 105 135 166 196 227 258 288 319 349 15
16 016 047 075 106 136 167 197 228 259 289 320 350 16
17 017 048 076 107 137 168 198 229 260 290 321 351 17
18 018 049 077 108 138 169 199 230 261 291 322 352 18
19 019 050 078 109 139 170 200 231 262 292 323 353 19
20 020 051 079 110 140 171 201 232 263 293 324 354 20
21 021 052 080 111 141 172 202 233 264 294 325 355 21
22 022 053 081 112 142 173 203 234 265 295 326 356 22
23 023 054 082 113 143 174 204 235 266 296 327 357 23
24 024 055 083 114 144 175 205 236 267 297 328 358 24
25 025 056 084 115 145 176 206 237 268 298 329 359 25
26 026 057 085 116 146 177 207 238 269 299 330 360 26
27 027 058 086 117 147 178 208 239 270 300 331 361 27
28 028 059 087 118 148 179 209 240 271 301 332 362 28
29 029 088 119 149 180 210 241 272 302 333 363 29
30 030 089 120 150 181 211 242 273 303 334 364 30
31 031 090 151 212 243 304 365 31
Day Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec Day

Leap Year Julian Date Calendar

Day Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec Day
1 001 032 061 092 122 153 183 214 245 275 306 336 1
2 002 033 062 093 123 154 184 215 246 276 307 337 2
3 003 034 063 094 124 155 185 216 247 277 308 338 3
4 004 035 064 095 125 156 186 217 248 278 309 339 4
5 005 036 065 096 126 157 187 218 249 279 310 340 5
6 006 037 066 097 127 158 188 219 250 280 311 341 6
7 007 038 067 098 128 159 189 220 251 281 312 342 7
8 008 039 068 099 129 160 190 221 252 282 313 343 8
9 009 040 069 100 130 161 191 222 253 283 314 344 9
10 010 041 070 101 131 162 192 223 254 284 315 345 10
11 011 042 071 102 132 163 193 224 255 285 316 346 11
12 012 043 072 103 133 164 194 225 256 286 317 347 12
13 013 044 073 104 134 165 195 226 257 287 318 348 13
14 014 045 074 105 135 166 196 227 258 288 319 349 14
15 015 046 075 106 136 167 197 228 259 289 320 350 15
16 016 047 076 107 137 168 198 229 260 290 321 351 16
17 017 048 077 108 138 169 199 230 261 291 322 352 17
18 018 049 078 109 139 170 200 231 262 292 323 353 18
19 019 050 079 110 140 171 201 232 263 293 324 354 19
20 020 051 080 111 141 172 202 233 264 294 325 355 20
21 021 052 081 112 142 173 203 234 265 295 326 356 21
22 022 053 082 113 143 174 204 235 266 296 327 357 22
23 023 054 083 114 144 175 205 236 267 297 328 358 23
24 024 055 084 115 145 176 206 237 268 298 329 359 24
25 025 056 085 116 146 177 207 238 269 299 330 360 25
26 026 057 086 117 147 178 208 239 270 300 331 361 26
27 027 058 087 118 148 179 209 240 271 301 332 362 27
28 028 059 088 119 149 180 210 241 272 302 333 363 28
29 029 060 089 120 150 181 211 242 273 303 334 364 29
30 030 090 121 151 182 212 243 274 304 335 365 30
31 031 091 152 213 244 305 366 31
Day Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec Day
CALERTS

CALERTS Command

The CALERTS command displays CICS data collection exception alerts.


Data collection values are displayed by the CALERTS command if the
current value exceeds a threshold definition.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CALERTS | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | [ GROUPTYPE type ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
| | [ WARNing | NORMal ] |
| | [ THRESH | ALL ] |
| | [ ACK | NOACK ] |
| | |
| | [ NAME name ] |
| | |
| | [ RSCESCope rscescope ] |
| | [ RSCENAme rscename ] |
| | [ RSCEQUal rscequal ] |
| | |
| | [ METGRoup metgroup ] |
| | [ METSUBGroup metsubgroup ] |
| | [ SUMMGRP summgrp ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
| GROUPTYPE | Specifies the logical group type. If the |
| | group type is not specified, the type CICSPLEX |
| | will be used. |
+------------------+--------------------------------------------------+
| WARNING | Display entries with a status greater than |
| | Normal. This is the default. |
+------------------+--------------------------------------------------+
| NORMAL | Display entries with a status of Normal or |
| | greater. |
+------------------+--------------------------------------------------+
| THRESH | Display data for only those resources that have |
| | an associated threshold definition. |
+------------------+--------------------------------------------------+
| ALL | Display data for all collected resources. |
| | *Note - Use of this keyword can generate large |
| | amounts of data. |
+------------------+--------------------------------------------------+
| ACK | Display acknowledged alerts. |
+------------------+--------------------------------------------------+
| NOACK | Do not display acknowledged alerts. |
+------------------+--------------------------------------------------+
| name | Limit the display to only those entries with a |
| | corresponding value in the Name field. |
+------------------+--------------------------------------------------+
| rscescope | Limit the display to only those entries with a |
| | corresponding value in the RsceScope field. |
+------------------+--------------------------------------------------+
| rscename | Limit the display to only those entries with a |
| | corresponding value in the RsceName field. |
+------------------+--------------------------------------------------+
| rscequal | Limit the display to only those entries with a |
| | corresponding value in the RsceQual field. |
+------------------+--------------------------------------------------+
| metgroup | Limit the display to only those entries with a |
| | corresponding value in the Group field. |
+------------------+--------------------------------------------------+
| metsubgroup | Limit the display to only those entries with a |
| | corresponding value in the Subgroup field. |
+------------------+--------------------------------------------------+
| summgrp | Limit the display to only those entries with a |
| | corresponding value in the SummGrp field. |
+------------------+--------------------------------------------------+

Information Fields
+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: Status,D,Pri,D,Name,A,RsceScope,A,RsceName,A,


RsceQual,A,Task,A,XSystem,A,

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| RsceScope | The CICS jobname of the owning resource. |
+------------------+--------------------------------------------------+
| Name | The variable name for the data collection |
| | element. |
+------------------+--------------------------------------------------+
| Value | The value last used during threshold processing. |
+------------------+--------------------------------------------------+
| Status | The current threshold status. |
+------------------+--------------------------------------------------+
| RsceName | The resource name. |
+------------------+--------------------------------------------------+
| RsceQual | The resource qualifier. |
+------------------+--------------------------------------------------+
| Task | The transaction number of the task that is |
| | being monitored dynamically. |
+------------------+--------------------------------------------------+
| Pri | The relative priority of the exception. |
+------------------+--------------------------------------------------+
| Ack | Indicates the alert has been acknowledged. |
| | |
| | Possible values are: |
| | |
| | ACK - Alert has been acknowledged |
| | blank - Alert has not been acknowledged |
+------------------+--------------------------------------------------+
| RuleType | The exception rule type. |
| | |
| | Possible values are: |
| | |
| | UPPER - Upper limit threshold |
| | LOWER - Lower limit threshold |
| | ABOVE - Above limit threshold |
| | BELOW - Below limit threshold |
| | CHANGE - Change in value threshold |
| | STATE - State exception |
| | |
| | For more information on these rule types see |
| | help topic Threshold and State Definitions |
+------------------+--------------------------------------------------+
| Description | A description of a variable. |
+------------------+--------------------------------------------------+
| Current | The current value is defined as the average |
| | resource value over the last "n" minutes. |
| | The number of minutes is defined by the |
| | duration value of an associated threshold |
| | definition. If no threshold definition is |
| | available, the interval is 2 minutes. |
+------------------+--------------------------------------------------+
| Average | The average value for the element over the last |
| | hour. |
+------------------+--------------------------------------------------+
| Median | The median value for the element over the last |
| | hour. |
+------------------+--------------------------------------------------+
| StdDev | The standard deviation for the element over the |
| | last hour. |
+------------------+--------------------------------------------------+
| Change | The difference between the duration average |
| | "Current" and the mean average "Average". |
+------------------+--------------------------------------------------+
| ChgStd | The "Change" value expressed as standard |
| | deviations. |
+------------------+--------------------------------------------------+
| Warning | The threshold limit value that the variable |
| | resource must reach to obtain the WARNING |
| | status. |
+------------------+--------------------------------------------------+
| Problem | The threshold limit value that the variable |
| | resource must reach to obtain the PROBLEM |
| | status. |
+------------------+--------------------------------------------------+
| Minimum | The minimum value for the element over the last |
| | hour. |
+------------------+--------------------------------------------------+
| Maximum | The maximum value for the element over the last |
| | hour. |
+------------------+--------------------------------------------------+
| Elapsed | The elapsed time that the metric has been in |
| | the current state or status. |
+------------------+--------------------------------------------------+
| Date | The date and time that the metric entered the |
| Time | current state or status. |
| | |
| | For a dynamic transaction alert, this is the |
| | last date and time the metric was evaluated. |
+------------------+--------------------------------------------------+
| AckElaps | The elapsed time since the alert has been |
| | acknowledged. |
+------------------+--------------------------------------------------+
| AckDate | The date and time that the alert was |
| AckTime | acknowledged. |
+------------------+--------------------------------------------------+
| Distribution | The distribution of values from minimum to |
| 0% ... 100% | maximum over the last hour separated into 11 |
| | buckets. Each bucket is equal to 1/10th of the |
| | maximum value. |
+------------------+--------------------------------------------------+
| -0 | The metrics value for the last 10 intervals. |
| . | |
| -9 | |
+------------------+--------------------------------------------------+
| Group | The group classification. |
+------------------+--------------------------------------------------+
| Subgroup | The subgroup classification. |
+------------------+--------------------------------------------------+
| Class | The internal data collection class name. |
+------------------+--------------------------------------------------+
| SummGrp | The summarization group ID. |
+------------------+--------------------------------------------------+
| Policy | Exception policy token |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| ACK | Invokes the METRIC command to acknowledge the alert. |
+----------+----------------------------------------------------------+
| CLR | Invokes the METRIC command to clear an acknowledged |
| | alert. |
+----------+----------------------------------------------------------+

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| CList | Issue the CLIST command for the selected metric. |
| | The following CLIST command is issued: |
| | |
| | CLIST member ,, rscescope rscename rscequal |
| | member metric name (MetAlias field on display). |
| | If the metric name contains the |
| | character "%", it is translated to the |
| | letter "P" in order to generate a |
| | valid member name |
| | rscescope Passed as parameter 1 |
| | rscename Passed as parameter 2 |
| | rscequal Passed as parameter 3 |
+----------+----------------------------------------------------------+
| Graph | Issue the GRAPH command for the selected metric. |
+----------+----------------------------------------------------------+
| Log | Invokes the XLOG command to display the exception |
| | history of the selected metric. |
+----------+----------------------------------------------------------+
| METric | Invokes the METRICS command for the selected metric |
| | name. |
+----------+----------------------------------------------------------+
| Plot | Issue the PLOT command for the selected metric. |
+----------+----------------------------------------------------------+
| RULe | Invokes the RULES command selecting the definition that |
| | is currently associated with the alert. |
+----------+----------------------------------------------------------+
| Select | Invokes the MOREINFO command for the selected metric. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
| OPTions | Set and display command options. |
+----------+----------------------------------------------------------+

OPTIONS Subcommand

Use the OPTIONS subcommand to set and display processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [options] |
+---------------+-----------------------------------------------------+

OPTIONS Parameter Values

The following table lists and explains the valid OPTIONS parameter
values. Any number of the values can be specified in any order.
The current settings of all options are always displayed in
response to the OPTIONS subcommand.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| Warning | Display only entries with a status level of Warning |
| | or greater. |
| Normal | Display all entries. This includes entries with a |
| | status level of Normal or greater. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_ALERTS. EXTRACT is only valid |
| | when the product is running under a TSO CLIST or |
| | REXX exec. EXTRACT can be specified alone or in |
| | combination with any other OPTIONS keywords. |
+---------------+-----------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CALERTS command security


CAMASM

CAMASM Command

The CAMASM command displays address space management information


for those address spaces that are being managed by CAMASTER.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| CAMASM | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYSTEM | This forces cross system data collection to be |
| XSDATA | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYSTEM | This forces cross system data collection to be |
| NOXSDATA | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Component,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Component | Component name |
+------------------+--------------------------------------------------+
| Parmlib | The PARMLIB member name. |
+------------------+--------------------------------------------------+
| Init | Initialization routine. |
+------------------+--------------------------------------------------+
| ASName | Address space name. |
+------------------+--------------------------------------------------+
| NoSt | This field contains NOST if the address space |
| | is not to be restarted. |
+------------------+--------------------------------------------------+
| Date | Address space creation date and time. |
| Time | |
+------------------+--------------------------------------------------+
| ASID | The hexadecimal address space ID. |
+------------------+--------------------------------------------------+
| ASCB | The ASCB address for the job. |
+------------------+--------------------------------------------------+
| ROff | This field contains ROFF if restart |
| | eligibility has been disabled. |
+------------------+--------------------------------------------------+
| RstMaxI | The restart max in interval. |
+------------------+--------------------------------------------------+
| RstInvt | The restart interval. |
+------------------+--------------------------------------------------+
| RstDate | The date and time of the last restart. |
| RstTime | |
+------------------+--------------------------------------------------+
| RstCnt | The restart counter. |
+------------------+--------------------------------------------------+
| VReq | This field contains VREQ if the VERIFY |
| | component module is required. |
+------------------+--------------------------------------------------+
| Verify | The VERIFY component name. |
+------------------+--------------------------------------------------+
| Xmpt | This field contains XMPT if the ASCB is exempt |
| | from system dispatchability. |
+------------------+--------------------------------------------------+
| PXmt | This field contains PXMT if the ASCB is |
| | permanently exempt from system |
| | nondispatchability. |
+------------------+--------------------------------------------------+
| NoMT | This field contains NOMT if the ASCB must |
| | not be MEMTERMed unless a DAT error has |
| | occurred. |
+------------------+--------------------------------------------------+
| NoMD | This field contains NOMD if the ASCB must |
| | not be MEMTERMed even if a DAT error has |
| | occurred. |
+------------------+--------------------------------------------------+
| 1LPU | Specifies 1LPU if this ASCB is a first |
| | level preferred user. |
+------------------+--------------------------------------------------+
| 2LPU | This field contains 2LPU if this ASCB is a |
| | second level preferred user. |
+------------------+--------------------------------------------------+
| N2LP | This field contains N2LP if SRM SYSEVENT |
| | TRANSWAP should not set the 2LPU attribute. |
+------------------+--------------------------------------------------+
| Priv | This field contains PRIV if the address space |
| | is a privileged address space. |
+------------------+--------------------------------------------------+
| NoSW | This field contains NOSW if the address space |
| | is non-swappable. |
+------------------+--------------------------------------------------+
| Perm | This field contains PERM if the address space |
| | is a permanebt address space. |
+------------------+--------------------------------------------------+
| NCan | This field contains NCAN if the ASCB is |
| | noncancelable. |
+------------------+--------------------------------------------------+
| HPri | This field contains HPRI if the address space |
| | is a Hi-Priority system service. |
+------------------+--------------------------------------------------+
| NUrg | This field contains NURG if the address space |
| | provides Non-Urgent services. |
+------------------+--------------------------------------------------+
| KRgn | This field contains KRGN if this address space |
| | is to be kept. |
+------------------+--------------------------------------------------+
| ReUs | This field contains REUS if the address space |
| | requested a reusable ASID. |
+------------------+--------------------------------------------------+
| JbSp | This field contains JBSP if the address space |
| | is a JOBSPACE. |
+------------------+--------------------------------------------------+
| V31 | This field contains V31 if the ASCB is in |
| | virtual 31-bit storage. |
+------------------+--------------------------------------------------+
| SToken | The STOKEN of the ASCB. |
+------------------+--------------------------------------------------+
| ASParm | Address space parameters. |
+------------------+--------------------------------------------------+
| STParm | Start parameters. |
+------------------+--------------------------------------------------+
| Description | The component description. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
CAMASTER

CAMASTER Command

The CAMASTER command can be used to set or configure


CAMASTER services.

Command Syntax

+------------------+--------------------------------------------------+
| CAMASTER | function [parms] |
| | [options] |
+------------------+--------------------------------------------------+
| | Function and parameter syntax examples: |
| | |
| | Function Parameters |
| | ------------ ----------------------------------- |
| | PCSERV token action |
| | ZDMDISC token |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Function | Specify the function to be executed. |
+------------------+--------------------------------------------------+
| PCSERV | PC services |
| | Parms: |
| | token - sub-function token |
| | action - Action to be taken |
| | Valid values are: |
| | DISABLE |
| | ENABLE |
+------------------+--------------------------------------------------+
| ZDMDISC | CCS Data Mover disconnect |
| | Parms: |
| | token - connection token |
+------------------+--------------------------------------------------+
CAMPCS

CAMPCS Command

The CAMPCS command displays PC services that are managed by


CAMASTER.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| CAMPCS | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYSTEM | This forces cross system data collection to be |
| XSDATA | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYSTEM | This forces cross system data collection to be |
| NOXSDATA | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Token,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Token | The subfunction token. |
+------------------+--------------------------------------------------+
| Status | The status of the subfunction. |
| | |
| | Possible values are: |
| | DISABLED - The subfunction in disabled |
| | ENABLED - The subfunction in enabled |
| | |
+------------------+--------------------------------------------------+
| Jobname | The jobname that defined the subfunction. |
+------------------+--------------------------------------------------+
| ASID | The ASID of the address space that defined the |
| | subfunction. |
+------------------+--------------------------------------------------+
| Module | Module name |
+------------------+--------------------------------------------------+
| Release | Module release |
+------------------+--------------------------------------------------+
| Qualifier | Module qualifier |
+------------------+--------------------------------------------------+
| Execution | The number of times that the PC service has been |
| | executed. |
+------------------+--------------------------------------------------+
| Abend | The number of times that the PC service has |
| | abended. |
+------------------+--------------------------------------------------+
| XM | Indicates the PC service is cross-memory |
| | enabled. |
+------------------+--------------------------------------------------+
| Mode | The execution mode of the PC service. |
| | |
| | Possible values are: |
| | PROB - Problem state |
| | SUPV - Supervisor state |
| | |
+------------------+--------------------------------------------------+
| Priv | Indicates that the subfunction caller must |
| | be privileged. |
+------------------+--------------------------------------------------+
| PKC | PSW key control. |
| | |
| | Possible values are: |
| | EK - The EK field is used to set the |
| | execution key. |
| | PKC - The execution key is not set. The |
| | key is based on the current PSW key. |
| | |
+------------------+--------------------------------------------------+
| EK | The subfunction execution key. |
+------------------+--------------------------------------------------+
| EPAddr | The subfunction entry point. |
+------------------+--------------------------------------------------+
| EOT | Indicates that the PC service will be disabled |
| | at defining task end of task (EOT) event. |
+------------------+--------------------------------------------------+
| EOM | Indicates that the PC service will be disabled |
| | at defining address space end of memory (EOM) |
| | event. |
+------------------+--------------------------------------------------+
| Dump | Indicates that an SVC dump will be scheduled |
| | on subfunction errors. |
+------------------+--------------------------------------------------+
| Description | The subfunction description. |
+------------------+--------------------------------------------------+
| EnaDate | The date and time the PC service was enabled. |
| EnaTime | |
+------------------+--------------------------------------------------+
| DisDate | The date and time the PC service was disabled. |
| DisTime | |
+------------------+--------------------------------------------------+
| LPAToken | The LPA token value. |
+------------------+--------------------------------------------------+
| UserData | The user data that will be passed to the |
| | subfunction. |
+------------------+--------------------------------------------------+
| TCB | The TCB address that defined the subfunction. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
CAPCLOSE

CAPCLOSE Command

The CAPCLOSE command is used to close a capture data set


opened with the CAPOPEN command.

For information about the Event Capture Option, follow this


hyperlink to the Event Capture Option help topic.

For additional information about other Event Capture commands,


follow this hyperlink to an Event Capture Command Summary.

Command Syntax

+---------------+-----------------------------------------------------+
| CAPCLOSE | [optns] |
+---------------+-----------------------------------------------------+

Parameters

The following table lists and explains the valid CAPCLOSE


[optns] values.

+-------------------+-------------------------------------------------+
| Parameter | Description |
+-------------------+-------------------------------------------------+
| Descr string | Specifies the description to be associated with |
| | the captured event. This description overrides |
| | any description supplied by a CAPPARMS DESCR |
| | command. The description can be any string |
| | of characters from 1 to 48 characters long. |
| | If the string contains blanks or commas, then |
| | it must be enclosed in character delimiter |
| | characters. If it contains lowercase |
| | characters, then the CHARS string qualifier |
| | must also be used: |
| | |
| | DESCR c'lowercase preserved' |
| | |
+-------------------+-------------------------------------------------+
| Msg | Controls whether or not the "Capture closed" |
| NOMsg | informational message is displayed. The default |
| | is MSG. Warning and error messages are always |
| | displayed. |
+-------------------+-------------------------------------------------+

Notes

After a capture data set is closed, its name is assigned to


the variable &CAPDSN. This variable can be referenced in
other commands. For example:

CAPOPEN /* open a capture data set */


CAPIMMED /* capture the current command display */
CAPCLOSE /* close a capture data set */
FTPCA &CAPDSN /* FTP the capture data set to Support */
CAPEVENT &CAPDSN /* display capture data set contents */

This &CAPDSN variable has a value of "*CAPINIT" before any


capture data set has ever been opened. It has a value of
"*CAPOPEN" after a CAPOPEN command and before a CAPCLOSE.
CAPDISP

CAPDISP Command

The CAPDISP command is not a real command and cannot


be directly entered on the command line. The CAPDISP
command is used internally to display captured command
data when a S[elect] line command is entered on the
CAPEVENT display.

Command Syntax

The CAPDISP command can not be directly entered in the


primary command input field and therefore has no syntax.

Parameters

The CAPDISP command can not be directly entered in the


primary command input field and therefore has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| The following information field is only displayed when the |
| OPTIONS option is in effect. See the CAPDISP OPTIONS subcommand |
| below for more information. |
+------------------+--------------------------------------------------+
| Options | A list of the currently effective options. |
| | Placing the cursor on one of the displayed |
| | options and hitting the ENTER key will toggle |
| | the option value. Options that are not the |
| | default will be highlighted. |
+------------------+--------------------------------------------------+
| The following information fields are only displayed when the |
| INFO option is in effect. See the CAPDISP OPTIONS subcommand |
| below for more information. |
+------------------+--------------------------------------------------+
| CapDsn | The name of the capture data set whose contents |
| | are being displayed. |
+------------------+--------------------------------------------------+
| Member | The name of the member used to create the |
| | contents of the displayed capture data set. |
+------------------+--------------------------------------------------+
| Tot | If the capture display was entered from a |
| | CAPEVENT display that was entered from a |
| | CAPLIST or CAPMAINT display then this field |
| | will contain the total number of CAPLIST or |
| | CAPMAINT display rows that have a matching |
| | capture index, system name, and member name. |
| | Otherwise it will display "n/a". |
+------------------+--------------------------------------------------+
| IdxDsn | The name of the capture index data set name in |
| | which the capture data set is located. |
+------------------+--------------------------------------------------+
| System | The name of the system on which the capture |
| | data set was created. |
+------------------+--------------------------------------------------+
| Cur | If the capture display was entered from a |
| | CAPEVENT display that was entered from a |
| | CAPLIST or CAPMAINT display then this field |
| | will contain the current matching record number |
| | that is being displayed out of the "Tot" field |
| | described above. Othwise it will display "n/a". |
+------------------+--------------------------------------------------+

Data Fields

The CAPDISP command does not display any data of its own.
It only displays the captured command's data.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

The CAPDISP command has several subcommands that are


described below. Subcommands defined for the command
that the CAPDISP command is displaying are not valid
and they will be rejected.

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFresh | Refresh display data. Note that REFRESH refreshes the |
| | the CAPDISP display for any active SORT or SELECT |
| | command but it does not (and can not) refresh the |
| | captured command data. |
+----------+----------------------------------------------------------+
| OPTions | Set and display CAPDISP command options. |
+----------+----------------------------------------------------------+
| NEXt | Display the same command, screen, and title from the |
| | next captured event. |
+----------+----------------------------------------------------------+
| FORward | Display the same command, screen, and title from the |
| | next captured event. FORWARD is an alias for the NEXT |
| | subcommand. |
+----------+----------------------------------------------------------+
| PREvious | Display the same command, screen, and title from the |
| | previous captured event. |
+----------+----------------------------------------------------------+
| BACkward | Display the same command, screen, and title from the |
| | previous captured event. BACKWARD is an alias for the |
| | PREVIOUS subcommand. |
+----------+----------------------------------------------------------+
| FIRst | Display the same command, screen, and title from the |
| | first captured event. |
+----------+----------------------------------------------------------+
| LASt | Display the same command, screen, and title from the |
| | last captured event. |
+----------+----------------------------------------------------------+
| ORIginal | Display the same command, screen, and title from the |
| | capture data set that was used when the CAPDISP command |
| | was originally invoked. |
+----------+----------------------------------------------------------+
| GOOd | Display the same command, screen, and title from the |
| | last known good capture data set. |
+----------+----------------------------------------------------------+

NEXT, PREVIOUS, FIRST, and LAST Subcommands

The NEXT, PREVIOUS, FIRST, LAST, ORIGINAL, and GOOD


subcommands, collectively known as capture navigation
subcommands are only valid when the CAPDISP command
is invoked by the following steps.

1. The CAPLIST or CAPMAINT command is entered.

2. The CAPEVENT command is entered using a


S[elect] line command from the CAPLIST or
CAPMAINT command display for a row whose
"Member" field is not equal "***NA***".

3. The CAPDISP command is entered using a


S[elect] line command from the CAPEVENT
command display for a row whose "Type"
field equals "CMD".

If the above sequence is followed then the capture


navigation subcommands are valid. Each one requests
that the same command name, screen name, and title
be displayed from the requested capture data set
listed on the original CAPLIST or CAPMAINT command.
The capture data sets that are considered by the
navigation subcommands are, by default, those that
have matching capture index data set name, system
name, and member name. These match requirements can
be changed using the CAPDISP OPTIONS subcommand
described below.

The direction of the search that is implied by the


subcommand names of NEXT, PREVIOUS, FIRST, and LAST
is, by default, date and time sequence. FIRST is
the oldest capture data set, LAST is the newest,
NEXT is the next newer, and PREVIOUS is the previous
older. This search direction can be changed with
the CAPDISP OPTIONS subcommand described below.

OPTIONS Subcommand

The OPTIONS subcommand is used to set and display CAPDISP


command processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [optns] |
+---------------+-----------------------------------------------------+

The following table lists and explains the valid


OPTIONS parameter values. Any number of the values
can be specified in any order. The current settings
of all options are displayed in a message in response
to the OPTIONS subcommand when the NOOPTIONS option
is in effect. Otherwise they are displayed in the
"Options" information row.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| Options | Controls whether or not the CAPDISP information |
| NOOptions | row that contains the "Options" field is displayed. |
| | The default is OPTIONS. |
+---------------+-----------------------------------------------------+
| INFo | Controls whether or not the CAPDISP information |
| NOINFo | rows that contain the "CapDsn", "IdxDsn", "System", |
| | "Member", "Tot", and "Cur" fields are displayed. |
| | The defaultl is INFO. |
+---------------+-----------------------------------------------------+
| Index | Controls whether or not the capture index |
| NOIndex | data set name must be matched when deciding |
| | if a CAPLIST/CAPMAINT data record is valid |
| | for a CAPDISP navigation subcommand. The |
| | default is INDEX. |
+---------------+-----------------------------------------------------+
| System | Controls whether or not the system name must |
| NOSystem | be matched when deciding if a CAPLIST/CAPMAINT |
| | data record is valid for a CAPDISP navigation |
| | subcommand. The default is SYSTEM. |
+---------------+-----------------------------------------------------+
| Member | Controls whether or not the member name must |
| NOMember | be matched when deciding if a CAPLIST/CAPMAINT |
| | data record is valid for a CAPDISP navigation |
| | subcommand. The default is MEMBER. |
+---------------+-----------------------------------------------------+
| SOrt | Controls whether or not the list of matching |
| NOSOrt | CAPLIST/CAPMAINT data records that are selected |
| | are to be sorted in ascending creation time |
| | sequence. The default is SORT. If this option |
| | is SORT then NEXT and PREVIOUS have their |
| | natural time sequence meaning. If this option |
| | is NOSORT then the direction of NEXT and PREV |
| | mean down and up the original CAPLIST or |
| | CAPMAINT displayed data rows - whatever order |
| | those rows are in determines the meaning of |
| | NEXT and PREVIOUS. |
+---------------+-----------------------------------------------------+
| Update | Controls whether or not a CAPEVENT command |
| NOUpdate | with a new capture data set as a parameter |
| | will be stacked when the CAPDISP command ends |
| | due to a RETURN command. This will only occur |
| | when the capture data set displayed at the time |
| | CAPDISP ends is different that when it was |
| | first entered. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX exec variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_CAPDISP. This keyword is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. EXTRACT can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+---------------+-----------------------------------------------------+

Notes

o Using the NOMEMBER option will increase the likelihood


that a navigation subcommand will select a data set that
does not contain the required command, screen, and title.
When this happens you will receive the message

CAPT130E [subc] failed, no match found in capture data set

and the screen will be cleared. You can enter another


navigation subcommand which may work or may fail with
the same message as above. In this situation you can
use the GOOD or ORIGINAL subcommands. GOOD will take
you back to the most recent successfully displayed
capture data set and ORIGINAL will take you back to
the capture data set displayed when you first invoked
the CAPDISP command by a SELECT line command from the
CAPEVENT display.

o The capture index data set name, system name, and member
names that are compared against (as controlled by the
INDEX/NOINDEX, SYSTEM/NOSYSTEM, and MEMBER/NOMEMBER
options) are not the original values, they are the values
that are currently in effect. The current values are those
displayed in the CAPDISP information rows (assuming that
the INFO option is in effect).

o The capture navigation subcommands will never consider


a capture data set created with the capture immediate
process. These types of captures will display a member
of "***NA***" on the CAPLIST, CAPMAINT, or CAPEVENT
screens. These captures were created interactively
using the CAPOPEN, CAPIMMED, and CAPCLOSE commands.
CAPEVENT

CAPEVENT Command

The CAPEVENT command displays the contents of a capture data set and
allows the output from a captured command to be selected for redisplay.

For information about the Event Capture Option, follow this


hyperlink to the Event Capture Option help topic.

For additional information about other Event Capture commands,


follow this hyperlink to an Event Capture Command Summary.

Command Syntax

+------------------+--------------------------------------------------+
| CAPEVENT | capdsn |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| capdsn | The name of the capture data set to be |
| | displayed. If you currently have a capture |
| | data set opened to your session (using the |
| | CAPOPEN command) you can request this open |
| | capture data set by specifying a capture data |
| | set name of *. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Dsname | The capture data set name. |
+------------------+--------------------------------------------------+
| Volser | The capture data set volser. |
+------------------+--------------------------------------------------+
| Descr | The capture description. |
+------------------+--------------------------------------------------+
| Member | The CAPLIB member name. |
+------------------+--------------------------------------------------+
| SiteName | The site name if available. |
+------------------+--------------------------------------------------+
| SiteId | The site id if available. |
+------------------+--------------------------------------------------+
| CaseNum | The case number if available. |
+------------------+--------------------------------------------------+
| System | The name of the system on which the capture data |
| | set was created. |
+------------------+--------------------------------------------------+
| JobName | The jobname of the job that requested the |
| | capture. |
+------------------+--------------------------------------------------+
| Asid | The ASID of the job that requested the capture. |
+------------------+--------------------------------------------------+
| UserId | The userid that requested the capture. |
+------------------+--------------------------------------------------+
| TaskId | The taskid that requested the capture. |
+------------------+--------------------------------------------------+
| Created | The date and time the capture data set was |
| | created. |
+------------------+--------------------------------------------------+
| Expires | The expiration date of the capture data set. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Type | The type of data displayed on the row. |
| | Possible values are: |
| | |
| | ID Capture data set identification |
| | MBR CAPLIB member |
| | NOTE Capture notes |
| | CMD Captured command data |
| | |
| | Only the Title field below is filled in for |
| | types ID, MBR or NOTE. |
+------------------+--------------------------------------------------+
| Name | The captured command name. |
+------------------+--------------------------------------------------+
| Screen | The captured command screen name or blank if no |
| | screen name was associated with the command |
| | display. |
+------------------+--------------------------------------------------+
| Title | The captured command screen title or a user |
| | supplied title specified on the CAPIMMED command.|
+------------------+--------------------------------------------------+
| Norm | The total number of status fields in all |
| | captured command display records that are at the |
| | NORMAL level. |
+------------------+--------------------------------------------------+
| Warn | The total number of status fields in all |
| | captured command display records that are at the |
| | WARNING level. |
+------------------+--------------------------------------------------+
| Prob | The total number of status fields in all |
| | captured command display records that are at the |
| | PROBLEM level. |
+------------------+--------------------------------------------------+
| Msg | This value is MSG if the captured command data |
| | contains a message. Otherwise, it is blank. |
+------------------+--------------------------------------------------+
| XSys | This value is XSYS if the capture command data |
| | contains xsystem data. Otherwise, it is blank. |
+------------------+--------------------------------------------------+
| JobName | The jobname that was active at the time the |
| | command output was captured if the command is |
| | memory switch sensitive. Otherwise, it is blank. |
+------------------+--------------------------------------------------+
| Asid | The ASID that was active at the time the |
| | command output was captured if the command is |
| | memory switch sensitive. Otherwise, it is blank. |
+------------------+--------------------------------------------------+
| BlkCt | The count of blocks written for the captured |
| | command. |
+------------------+--------------------------------------------------+
| RecCt | The count of command display records captured. |
+------------------+--------------------------------------------------+
| CmpRt | The compression rate for the captured command |
| | data. |
+------------------+--------------------------------------------------+
| CmpCt | The count of blocks saved due to compression. |
+------------------+--------------------------------------------------+
| BlkNo | The relative block number of the first data |
| | block of captured command data. |
+------------------+--------------------------------------------------+
| Date | The date the command data was captured. |
+------------------+--------------------------------------------------+
| Time | The time the command data was captured. |
+------------------+--------------------------------------------------+
+------------------+--------------------------------------------------+
| CmdRow | The command row number. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------+----------------------------------------------------------+
| Command | Description |
+------------+----------------------------------------------------------+
| Select | Selects the captured command output data for redisplay. |
| (Type CMD) | Line commands, subcommands, and over-typeable input |
| | fields are not supported on the captured command output |
| | redisplay. |
+------------+----------------------------------------------------------+
| Select | Invokes the capture data set identification block detail |
| (Type ID) | display that includes the following information: |
| | |
| | Capture data set |
| | Dsname |
| | Volser |
| | Creation date |
| | Creation time |
| | Expiration date |
| | Release |
| | Build |
| | Capture data version |
| | Format version |
| | Data record prefix version |
| | Caplib data set |
| | Dsname |
| | Volser |
| | Member |
| | Parameters |
| | Capture |
| | Site name |
| | Site id |
| | Case number |
| | Description |
| | System name |
| | Return code |
| | Reason code |
| | Error codes |
| | Error code 1 |
| | Error code 2 |
| | Abend code |
| | Command count |
| | Block count |
| | Blocks saved |
| | Requested by |
| | JobName |
| | JobId |
| | Asid |
| | UserId |
| | TaskId |
| | Captured by |
| | JobName |
| | JobId |
| | Asid |
+------------+----------------------------------------------------------+
| Select | Displays the CAPLIB member used to create the capture |
| (Type MBR) | data set. |
| | |
| | The member content shown here will not reflect any |
| | commands included in the member due to an )IF statement |
| | that referenced a CLIST parameter variable such as &1, |
| | even though those commands may have been executed as |
| | part of the capture. |
+------------+----------------------------------------------------------+
| Select | Invokes the CAPNOTE command to display and possibly |
| (Type NOTE)| edit the note. |
+------------+----------------------------------------------------------+
| Message | Displays any message contained in the capture command |
| Msg | data. This is not valid for types ID and MBR. |
+------------+----------------------------------------------------------+
| Dump | Displays diagnostic data. The output of this command is |
| | subject to change without notice. This line command is |
| | not intended for customer use except at the direction of |
| | technical support. |
+------------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
| OPTions | Set and display CAPEVENT command options. |
+----------+----------------------------------------------------------+

OPTIONS Subcommand

The OPTIONS subcommand is used to set and display CAPEVENT command


processing options.
OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [optns] |
+---------------+-----------------------------------------------------+

The following table lists and explains the valid OPTIONS parameter
values. Any number of the values can be specified in any order. The
current settings of all options are always displayed in response to
the OPTIONS subcommand.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| Ident | Controls the display of the ID line type. The |
| NOIdent | initial default is IDENT. |
+---------------+-----------------------------------------------------+
| Member | Controls the display of the MBR line type. The |
| NOMember | initial default is MEMBER. |
+---------------+-----------------------------------------------------+
| Note | Controls the display of the NOTE line type. The |
| NONote | initial default is NOTE. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_CAPEVENT. This keyword is only |
| | valid when the product is running under a TSO CLIST |
| | or REXX EXEC. EXTRACT can be specified alone or in |
| | combination with any other OPTIONS keywords. |
+---------------+-----------------------------------------------------+
CAPIMMED

CAPIMMED Command

The CAPIMMED command is used to capture the current


command's display data to an open capture dataset.

For information about the Event Capture Option, follow this


hyperlink to the Event Capture Option help topic.

For additional information about other Event Capture commands,


follow this hyperlink to an Event Capture Command Summary.

Command Syntax

+------------------+--------------------------------------------------+
| CAPIMMED | [optns] |
+------------------+--------------------------------------------------+

Parameters

The following table lists and explains the valid


CAPIMMED [optns] values.

+-------------------+-------------------------------------------------+
| Parameter | Description |
+-------------------+-------------------------------------------------+
| Descr string | Specifies the description to be associated with |
| | the captured event. This description overrides |
| | any description supplied by a CAPPARMS DESCR |
| | command. The description can be any string |
| | of characters from 1 to 48 characters long. |
| | If the string contains blanks or commas, then |
| | it must be enclosed in character delimiter |
| | characters. If it contains lowercase |
| | characters, then the CHARS string qualifier |
| | must also be used: |
| | |
| | DESCR c'lowercase preserved' |
| | |
+-------------------+-------------------------------------------------+
| Title string | Specifies the title to be associated with |
| | the captured event. This title overrides |
| | the command screen title and is displayed |
| | in the Title field on the CAPEVENT command |
| | display. The title can be any string of |
| | characters from 1 to 48 characters long. |
| | If the string contains blanks or commas it |
| | must be enclosed in character delimiter |
| | characters. If it contains lowercase |
| | characters, then the CHARS string qualifier |
| | must also be used: |
| | |
| | TITLE c'lowercase preserved' |
| | |
+-------------------+-------------------------------------------------+
| Msg | Controls whether or not the "Capture complete" |
| NOMsg | informational message is displayed. The default |
| | is MSG. Warning and error messages are always |
| | displayed. |
+-------------------+-------------------------------------------------+
CAPLIB

CAPLIB Command

The CAPLIB command displays your personal CAPLIB library,


the site CAPLIB library, and the system CAPLIB library.

For information about other related library listing commands see:


Library Listing Command Summary

Command Syntax

+---------------+------------------------------------------------------------+
| CAPLIB | |
+---------------+------------------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Options | This field lists the following option keywords: |
| | |
| | ALL |
| | DUPLICAT |
| | UNIQUE |
| | |
| | These fields are cursor selectable. Positioning the cursor |
| | over one of the above keywords and hitting the ENTER key |
| | will invoke the subcommand of the same name. |
| | |
| | If SET TABINFOOPTS YES is in effect then you can use the |
| | NEWLINE or TAB keys to position the cursor to the keyword. |
| | |
| | Click here to see your TABINFOOPTS setting. |
| | Click here to set your TABINFOOPTS setting to YES. |
| | Click here to set your TABINFOOPTS setting to NO. |
| | Click here to view help for the SET TABINFOOPTS option. |
| | |
+---------------+------------------------------------------------------------+
| Libraries | The total number of libraries listed. |
+---------------+------------------------------------------------------------+
| Alloc | The number of libraries successfully allocated. |
+---------------+------------------------------------------------------------+
| Open | The number of libraries successfully opened. |
+---------------+------------------------------------------------------------+
| The following fields are displayed only after a WHERE subcommand: |
+---------------+------------------------------------------------------------+
| Search | The number of libraries searched by the WHERE subcommand. |
+---------------+------------------------------------------------------------+
| Found | The number of matches found by the WHERE subcommand. |
+---------------+------------------------------------------------------------+
| Member | The member name searched for by the WHERE subcommand. |
+---------------+------------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Type | The type of CAPTURE library. |
| | Possible values are: |
| | |
| | USER User CAPTURE library specified by a |
| | SET CAPLIB command. |
| | |
| | SITE Site CAPTURE library specified by the |
| | Dsn-Site-CAPLIB parameter in the |
| | System Configuration Options member. |
| | |
| | SYSTEM System CAPTURE library specified by the |
| | Dsn-System-CAPLIB parameter in the |
| | System Configuration Options member. |
+---------------+------------------------------------------------------------+
| Dataset-Name | The CAPTURE library data set name. |
+---------------+------------------------------------------------------------+
| Volser | The volume serial number. |
+---------------+------------------------------------------------------------+
| Message | Message information generated while accessing a data set. |
+---------------+------------------------------------------------------------+
| The following fields are displayed only after a WHERE subcommand: |
+---------------+------------------------------------------------------------+
| VV.MM | The version and modification level of the member. |
+---------------+------------------------------------------------------------+
| Created | The date the member was created. |
+---------------+------------------------------------------------------------+
| UpdDate | The date the member was last updated. |
+---------------+------------------------------------------------------------+
| UpdTm | The time the member was last updated. |
+---------------+------------------------------------------------------------+
| Size | The current size of the member in number of records. |
+---------------+------------------------------------------------------------+
| User-Id | The user ID of the last ID to modify the member. |
+---------------+------------------------------------------------------------+
| Found | When a WHERE subcommand is performed with a masked member |
| | name, this is the count of how many members matched the |
| | mask within the data set. |
+---------------+------------------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Zap | Invokes the ZAP command for the data set. |
+---------------+------------------------------------------------------------+
| ZRO | Invokes the ZAP command with the READONLY option. |
+---------------+------------------------------------------------------------+
| ZRW | Invokes the ZAP command with the READWRITE option. |
+---------------+------------------------------------------------------------+

Navigation Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Browse | Invoke the BROWSE command for the data set. This is valid |
| | only when ISPF services are available. If a previous |
| | WHERE subcommand found a match in the selected data set, |
| | then the BROWSE command invoked includes the searched-for |
| | member name. |
+---------------+------------------------------------------------------------+
| DSinfo | Invokes the DSINFO command for the data set. |
| Info | |
+---------------+------------------------------------------------------------+
| Edit | Invokes the EDIT command for the data set. This is valid |
| | only when ISPF services are available. If a previous |
| | WHERE subcommand found a match in the selected data set, |
| | then the EDIT command invoked includes the searched-for |
| | member name. |
+---------------+------------------------------------------------------------+
| ENQueue | Invokes the ENQUEUE command specifying SYSDSN as the |
| NQ | qname and the selected data set name as the rname. |
+---------------+------------------------------------------------------------+
| Listdir | Invokes the LISTDIR command for the data set. If a |
| Ldir | previous WHERE subcommand found a match in the selected |
| | data set, then the LISTDIR command invoked includes the |
| | searched-for member name. |
+---------------+------------------------------------------------------------+
| View | Invokes the VIEW command for the data set. This is valid |
| | only when ISPF services are available. If a previous |
| | WHERE subcommand found a match in the selected data set, |
| | then the VIEW command invoked includes the searched-for |
| | member name. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| ALL | Invokes the LISTMDIR command with the ALL option to |
| | display all members in all libraries. |
+---------------+------------------------------------------------------------+
| CLEAR | Clears the results of a previous WHERE subcommand. |
+---------------+------------------------------------------------------------+
| DUPLICAT | Invokes the LISTMDIR command with the DUPLICAT option |
| | to display duplicate members in all libraries. Duplicate |
| | members are members that exist in more than one library. |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh the display data. |
+---------------+------------------------------------------------------------+
| UNIQUE | Invokes the LISTMDIR command with the UNIQUE option |
| | to display unique members in all libraries. Unique |
| | members are member that exist in only one library. |
+---------------+------------------------------------------------------------+
| WHERE | Searches all libraries for a specific or generic module |
| | name. |
+---------------+------------------------------------------------------------+

WHERE Subcommand

Use the WHERE subcommand to search all CAPLIB library


data sets for a specific or generic member and display
summary information about each member found.

WHERE Subcommand Format

+---------------+------------------------------------------------------------+
| WHERE | membername |
+---------------+------------------------------------------------------------+

WHERE Parameters Explained

+---------------+------------------------------------------------------------+
| Parameter | Explanation |
+---------------+------------------------------------------------------------+
| name | The name of the member to search for. Masking characters |
| | can be used to search for a generic member name. Your |
| | mask characters are: |
| | |
| | = Variable length mask character |
| | * Fixed length mask character |
| | |
+---------------+------------------------------------------------------------+

CLEAR Subcommand

Use the CLEAR subcommand to clear the results displayed


by a previous WHERE subcommand. The CLEAR subcommand has
no parameters.

CLEAR Subcommand Format

+---------------+------------------------------------------------------------+
| CLEAR | |
+---------------+------------------------------------------------------------+

Related Information

Library concatenation - USER, SITE and SYSTEM


CAPLIST

CAPLIST Command

The CAPLIST command displays a list of captured events


contained in one or more capture index data sets.

For information about the Event Capture Option, follow this


hyperlink to the Event Capture Option help topic.

For additional information about other Event Capture commands,


follow this hyperlink to an Event Capture Command Summary.

Command Syntax

+------------------+--------------------------------------------------+
| CAPLIST | [kwd kwd ... kwd]|idxdsn|idxhlq] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| kwd | One or more of the following keywords |
| | |
| | Dsname Specifies that the capture index |
| | dataset from the System |
| | Configuration Options parameter |
| | Dsn-System-CAPINDEX. |
| | |
| | The SYSTEM and USER keywords below |
| | determine whether the system or |
| | user CAPTURE PARMLIB member is |
| | used. This keyword is mutually |
| | exclusive with the HLQUAL keyword. |
| | If both are specified, the last |
| | is used. |
| | |
| | Hlqual Specifies that the capture index |
| | high-level qualifier from the |
| | System Configuration Options |
| | parameter Dsn-System-CAPINDEX-HLQ. |
| | |
| | The SYSTEM and USER keywords below |
| | determine whether the system or |
| | user CAPTURE PARMLIB member is |
| | used. This keyword is mutually |
| | exclusive with the DSNAME keyword. |
| | If both are specified, the last |
| | is used. |
| | |
| | System Specifies that the DSNAME or |
| | HLQUAL parameter above refers to |
| | the system CAPTURE PARMLIB member. |
| | This keyword is mutually exclusive |
| | with the USER keyword. If both |
| | are specified, the last is used. |
| | |
| | User Specifies that the DSNAME or |
| | HLQUAL parameter above refers to |
| | the user CAPTURE PARMLIB member. |
| | This keyword is mutually exclusive |
| | with the SYSTEM keyword. If both |
| | are specified, the last is used. |
| | |
+------------------+--------------------------------------------------+
| idxdsn | A specific capture index data set name. The |
| | contents of the specific data set are displayed. |
+------------------+--------------------------------------------------+
| idxhlq | A generic capture index data set name. The |
| | contents of all matching capture indexes found |
| | in the catalog are displayed. |
+------------------+--------------------------------------------------+
| [omitted] | If parameters are specified, then the defaults |
| | used are determined by the current settings of |
| | the DSNAME/HLQUAL and SYSTEM/USER options of |
| | the CAPLIST OPTIONS subcommand described below. |
| | The initial defaults are DSNAME and SYSTEM. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| |
| The following fields are displayed for a specific capture |
| index data set: |
| |
+------------------+--------------------------------------------------+
| System index dsn | The specific capture index data set name. |
| -or- | |
| User index dsn | |
+------------------+--------------------------------------------------+
| Volser | The volser of the capture index data set. |
+------------------+--------------------------------------------------+
| |
| The following fields are displayed for a generic capture |
| index data set: |
| |
+------------------+--------------------------------------------------+
| System index hlq | The generic capture index data set name. |
| -or- | |
| User index hlq | |
+------------------+--------------------------------------------------+
| Count | A count of matching capture index data set |
| | names. |
+------------------+--------------------------------------------------+
| |
| The following fields are always displayed: |
| |
+------------------+--------------------------------------------------+
| Total Recs | The totals for all requested capture index data |
| Blks | sets, even if the display row is not currently |
| Expd | selected (using the SELECT command). |
| | |
| | Recs Capture index records |
| | Blks Capture data set blocks allocated |
| | Expd Expired capture data sets |
+------------------+--------------------------------------------------+
| Select Recs | The totals for the currently selected display |
| Blks | rows for all requested capture index data sets. |
| Expd | |
| | Recs Capture index records |
| | Blks Capture data set blocks allocated |
| | Expd Expired capture data sets |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| CreDate | The date the capture data set was created. |
+------------------+--------------------------------------------------+
| CreTime | The time the capture data set was created. |
+------------------+--------------------------------------------------+
| Sysname | The name of the system on which the capture data |
| | set was created. |
+------------------+--------------------------------------------------+
| Member | The CAPLIB member name used to create the |
| | capture data set. |
+------------------+--------------------------------------------------+
| Descr | A description of the captured event. |
+------------------+--------------------------------------------------+
| Status | The highest status of all fields in all command |
| | displays in the captured data. Valid values |
| | are: |
| | |
| | blank No status fields were found |
| | NORMAL Highest status found was normal |
| | WARNING Highest status found was warning |
| | PROBLEM Highest status found was problem |
| | |
+------------------+--------------------------------------------------+
| Retn | The capture data set retention period in days. |
+------------------+--------------------------------------------------+
| ExpDate | The date on which the capture data set expires. |
+------------------+--------------------------------------------------+
| Norm | A count of the number of capture command |
| | displays that had at least one status field at |
| | the NORMAL level. |
+------------------+--------------------------------------------------+
| Warn | A count of the number of capture command |
| | displays that had at least one status field at |
| | the WARNING level. |
+------------------+--------------------------------------------------+
| Prob | A count of the number of capture command |
| | displays that had at least one status field at |
| | the PROBLEM level. |
+------------------+--------------------------------------------------+
| Parms | Any parameters passed to the CAPLIB member at |
| | capture execution time. |
+------------------+--------------------------------------------------+
| RAsid | The ASID of the capture requestor. |
+------------------+--------------------------------------------------+
| RJobName | The jobname of the capture requestor. |
+------------------+--------------------------------------------------+
| RJobId | The jobid of the capture requestor. |
+------------------+--------------------------------------------------+
| RUserId | The userid of the capture requestor. |
+------------------+--------------------------------------------------+
| RTaskId | The taskid of the capture requestor. |
+------------------+--------------------------------------------------+
| CAsid | The ASID of the capture task. |
+------------------+--------------------------------------------------+
| CJobName | The jobname of the capture task. |
+------------------+--------------------------------------------------+
| CJobId | The jobid of the capture task. |
+------------------+--------------------------------------------------+
| CmdCt | The count of command displays captured in the |
| | capture data set. |
+------------------+--------------------------------------------------+
| BlkCt | The total number of blocks written to the |
| | capture data set. |
+------------------+--------------------------------------------------+
| CmpRt | The compression rate of the capture data set. |
+------------------+--------------------------------------------------+
| CmpCt | A count of capture data set block saved due to |
| | compression. |
+------------------+--------------------------------------------------+
| Rc | The capture task return code. |
+------------------+--------------------------------------------------+
| Rs | The capture task reason code. |
+------------------+--------------------------------------------------+
| ErrCode1 | The capture task error code 1. |
+------------------+--------------------------------------------------+
| ErrCode2 | The capture task error code 2. |
+------------------+--------------------------------------------------+
| AbnCode | The capture task abend completion code. |
+------------------+--------------------------------------------------+
| Rels | The product release of the capture task that |
| | created the capture data set. |
+------------------+--------------------------------------------------+
| Bld | The product build number of the capture task |
| | that created the capture data set. |
+------------------+--------------------------------------------------+
| CapDsname | The capture data set name. |
+------------------+--------------------------------------------------+
| CapVol | The capture data set volser. |
+------------------+--------------------------------------------------+
| IdxDsname | The capture index data set name. |
+------------------+--------------------------------------------------+
| CaseNum | The case number. |
+------------------+--------------------------------------------------+
| SiteId | The site identifier. |
+------------------+--------------------------------------------------+
| SiteName | The site name. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands


Action Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| FTPCA | Invokes the FTPCA command to FTP the selected capture |
| | data set to Technical Support. |
+----------+----------------------------------------------------------+
| Edit | Invokes the ISPF EDIT command for the selected capture |
| | data set. This is only valid when ISPF services are |
| | available. |
+----------+----------------------------------------------------------+
| Zap | Invokes the ZAP command for the selected capture data |
| | set. |
+----------+----------------------------------------------------------+
| ZRO | Invokes the ZAP command with the READONLY option for |
| | the selected capture data set. |
+----------+----------------------------------------------------------+
| ZRW | Invokes the ZAP command with the READWRITE option for |
| | the selected capture data set. |
+----------+----------------------------------------------------------+

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Select | Invokes the CAPEVENT command to list the contents of the |
| | selected capture data set. |
+----------+----------------------------------------------------------+
| Maint | Invokes the CAPMAINT command for the selected capture |
| | index data set. |
+----------+----------------------------------------------------------+
| Note | Invokes the CAPNOTE command for the selected capture |
| | data set. |
+----------+----------------------------------------------------------+
| DSinfo | Invokes the DSINFO command to display information about |
| Info | the selected capture data set. |
+----------+----------------------------------------------------------+
| LISTCat | Invokes the IDCAMS command to execute a LISTCAT against |
| LCat | the selected capture data set. |
+----------+----------------------------------------------------------+
| LCIndex | Invokes the IDCAMS command to execute a LISTCAT against |
| | the selected capture index data set. |
+----------+----------------------------------------------------------+
| IDent | Invokes the capture index record detail display that |
| | includes the following information: |
| | |
| | Capture index |
| | Dsname |
| | Volser |
| | Capture data set |
| | Dsname |
| | Volser |
| | Creation date |
| | Creation time |
| | Expiration date |
| | Release |
| | Build |
| | Capture data version |
| | Format version |
| | Data record prefix version |
| | Caplib data set |
| | Dsname |
| | Volser |
| | Member |
| | Parameters |
| | Capture |
| | Site name |
| | Site id |
| | Case number |
| | Description |
| | System name |
| | Return code |
| | Reason code |
| | Error codes |
| | Error code 1 |
| | Error code 2 |
| | Abend code |
| | Command count |
| | Block count |
| | Blocks saved |
| | Requested by |
| | JobName |
| | JobId |
| | Asid |
| | UserId |
| | TaskId |
| | Captured by |
| | JobName |
| | JobId |
| | Asid |
| | |
+----------+----------------------------------------------------------+
| Browse | Invokes the ISPF BROWSE command for the selected capture |
| | data set. This is only valid when ISPF services are |
| | available. |
+----------+----------------------------------------------------------+
| View | Invokes the ISPF VIEW command for the selected capture |
| | data set. This is only valid when ISPF services are |
| | available. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFresh | Refreshes the display data. Note that REFRESH refreshes |
| | the CAPLIST display for any active SELECT or SORT |
| | command but does not re-read the capture index data |
| | sets. To re-read the capture index data sets, you must |
| | either reissue the CAPLIST command with the same |
| | parameters or issue the REBUILD command listed below. |
+----------+----------------------------------------------------------+
| REBuild | Rebuilds the display data. The REBUILD command re-reads |
| | the current capture index data sets. It is the same as |
| | reissuing the CAPLIST command with the same parameters |
| | as originally entered. |
+----------+----------------------------------------------------------+
| OPTions | Set and display CAPLIST command options. |
+----------+----------------------------------------------------------+
OPTIONS Subcommand

The OPTIONS subcommand is used to set and display CAPLIST


command processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [optns] |
+---------------+-----------------------------------------------------+

The following table lists and explains the valid


OPTIONS parameter values. Any number of the values
can be specified in any order. The current settings
of all options are always displayed in response to
the OPTIONS subcommand.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| Dsname | Sets the default option to be used when the CAPLIST |
| Hlqual | command is entered with no parameters. The initial |
| | default is DSNAME. |
+---------------+-----------------------------------------------------+
| System | Sets the default option to be used then the CAPLIST |
| User | command is entered with no parameters. the initial |
| | default is SYSTEM. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX exec variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_CAPLIST. This keyword is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. EXTRACT can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+---------------+-----------------------------------------------------+
CAPMAINT

CAPMAINT Command

The CAPMAINT command displays a list of captured events


contained in one or more capture index data sets and also
provides facilities for maintenance activities on capture
index data sets and event capture data sets.

For information about the Event Capture Option, follow this


hyperlink to the Event Capture Option help topic.

For additional information about other Event Capture commands,


follow this hyperlink to an Event Capture Command Summary.

Command Syntax

+------------------+--------------------------------------------------+
| CAPMAINT | [kwd kwd ... kwd]|idxdsn|idxhlq] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| kwd | One or more of the following keywords |
| | |
| | Dsname Specifies that the capture index |
| | dataset from the System |
| | Configuration Options parameter |
| | Dsn-System-CAPINDEX. |
| | |
| | The SYSTEM and USER keywords below |
| | determine whether the system or |
| | user CAPTURE PARMLIB member is |
| | used. This keyword is mutually |
| | exclusive with the HLQUAL keyword. |
| | If both are specified, the last |
| | is used. |
| | |
| | Hlqual Specifies that the capture index |
| | high-level qualifier from the |
| | System Configuration Options |
| | parameter Dsn-System-CAPINDEX-HLQ. |
| | |
| | The SYSTEM and USER keywords below |
| | determine whether the system or |
| | user CAPTURE PARMLIB member is |
| | used. This keyword is mutually |
| | exclusive with the DSNAME keyword. |
| | If both are specified, the last |
| | is used. |
| | |
| | System Specifies that the DSNAME or |
| | HLQUAL parameter above refers to |
| | the system CAPTURE PARMLIB member. |
| | This keyword is mutually exclusive |
| | with the USER keyword. If both |
| | are specified, the last is used. |
| | |
| | User Specifies that the DSNAME or |
| | HLQUAL parameter above refers to |
| | the user CAPTURE PARMLIB member. |
| | This keyword is mutually exclusive |
| | with the SYSTEM keyword. If both |
| | are specified, the last is used. |
| | |
+------------------+--------------------------------------------------+
| idxdsn | A specific capture index data set name. The |
| | contents of the specific data set are displayed. |
+------------------+--------------------------------------------------+
| idxhlq | A generic capture index data set name. The |
| | contents of all matching capture indexes found |
| | in the catalog are displayed. |
+------------------+--------------------------------------------------+
| [omitted] | If no parameters are specified, then the |
| | defaults used are determined by the current |
| | settings of the DSNAME/HLQUAL and SYSTEM/USER |
| | options of the CAPMAINT OPTIONS subcommand |
| | described below. The initial defaults are |
| | DSNAME and SYSTEM. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| |
| The following fields are displayed for a specific capture |
| index data set: |
| |
+------------------+--------------------------------------------------+
| System index dsn | The specific capture index data set name. |
| -or- | |
| User index dsn | |
+------------------+--------------------------------------------------+
| Volser | The volser of the capture index data set. |
+------------------+--------------------------------------------------+
| |
| The following fields are displayed for a generic capture |
| index data set: |
| |
+------------------+--------------------------------------------------+
| System index hlq | The generic capture index data set name. |
| -or- | |
| User index hlq | |
+------------------+--------------------------------------------------+
| Count | A count of matching capture index data set |
| | names. |
+------------------+--------------------------------------------------+
| |
| The following fields are always displayed: |
| |
+------------------+--------------------------------------------------+
| Total Recs | Totals for all requested capture index data |
| Blks | sets, even if the display row is not currently |
| Expd | selected (using the SELECT command). |
| | |
| | Recs Capture index records |
| | Blks Capture data set blocks allocated |
| | Expd Expired capture data sets |
| | |
+------------------+--------------------------------------------------+
| Select Recs | Totals for the currently selected display rows |
| Blks | for all requested capture index data sets. |
| Expd | |
| | Recs Capture index records |
| | Blks Capture data set blocks allocated |
| | Expd Expired capture data sets |
| | |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| IdxStat | The status of the index record or of the capture |
| | data set pointed to by the index record Valid |
| | values are: |
| | |
| | EXPIRED The capture data set is expired. |
| | |
| | ERASED The index record has been erased. |
| | |
| | ERASEQER A request was made to erase the |
| | index record but the record could |
| | not be erased because an exclusive |
| | ENQ against the index data set |
| | failed. |
| | |
| | ERASEAER A request was made to erase the |
| | index record but the record could |
| | not be erased because allocation |
| | failed for the index data set. |
| | |
| | ERASEOER A request was made to erase the |
| | index record but the record could |
| | not be erased because OPEN failed |
| | for the index data set. |
| | |
| | ERASEERR The attempt to erase the index |
| | record failed. |
| | |
| | ERASESKP A request was made to erase the |
| | index record but the attempt to |
| | erase the index record was skipped |
| | because of a prior error against |
| | the same index data set (a |
| | previous enqueue, allocation, or |
| | open error occurred). |
| | |
| | If an error status occurs in response to a |
| | CLEANUP subcommand, then use the DETAIL |
| | subcommand to view detailed information about |
| | the error. |
| | |
| | If an error status occurs in response to a |
| | CLEANUP, PURGE, or ERASE line command, then use |
| | the LISTLOG command to view further information |
| | about the error. |
+------------------+--------------------------------------------------+
| CapStat | The status of the capture data set pointed to by |
| | the capture index record. Valid values are: |
| | |
| | DELETED The capture data set was deleted. |
| | |
| | DELETERR An attempt to delete the capture |
| | data set failed. |
| | |
| | MIGRATED The capture data set has been |
| | migrated. |
| | |
| | NOTFOUND The capture data set was not found |
| | in the catalog. |
| | |
| | If the DELETERR status occurs in response to a |
| | CLEANUP subcommand, then use the DETAIL |
| | subcommand to view detailed information about |
| | the error. |
| | |
| | If the DELETERR status occurs in response to a |
| | CLEANUP, PURGE, or DELETE line command, then |
| | use the LISTLOG command to view further |
| | information about the error. |
+------------------+--------------------------------------------------+
| CreDate | The date the capture data set was created. |
+------------------+--------------------------------------------------+
| CreTime | The time the capture data set was created. |
+------------------+--------------------------------------------------+
| ExpDate | The date on which the capture data set expires. |
| | The expiration date can be changed by overtyping |
| | the displayed value with: |
| | |
| | date The date you want the capture data |
| | set to expire. You must specify the |
| | full date using your date format. |
| | The date entered must be on or after |
| | the creation date and on or before |
| | Sept. 17, 2042. |
| | |
| | +nnnn A relative adjustment of the current |
| | -nnnn expiration date by plus or mins nnnn |
| | days where nnnn is a number from 0 to |
| | 9999. If the current expiration date |
| | is PERM, then the adjustment is from |
| | the creation date. The resulting |
| | date must be on or after the creation |
| | date and on or before Sept. 17, 2042. |
| | |
| | PERM The keyword PERM specifies that the |
| | capture data set is permanent and |
| | will never be a candidate for |
| | automatic deletion by the CLEANUP |
| | subcommand |
| | |
| | If the expiration date is successfully updated, |
| | then the ExpDate field displays the actual |
| | expiration date or PERM and the Retn field is |
| | updated to show the number of days the new |
| | expiration date is after the creation date or |
| | PERM. If the calculated Retn value is greater |
| | than 9999, then 9999 is displayed. |
+------------------+--------------------------------------------------+
| Sysname | The name of the system on which the capture data |
| | set was created. |
+------------------+--------------------------------------------------+
| Member | The CAPLIB member name used to create the |
| | capture data set. |
+------------------+--------------------------------------------------+
| Descr | A description of the captured event. |
+------------------+--------------------------------------------------+
| Retn | The capture data set retention period in days. |
+------------------+--------------------------------------------------+
| Parms | Specifies any parameters passed to the CAPLIB |
| | member at capture execution time. |
+------------------+--------------------------------------------------+
| RAsid | The ASID of the capture requestor. |
+------------------+--------------------------------------------------+
| RJobName | The jobname of the capture requestor. |
+------------------+--------------------------------------------------+
| RJobId | The jobid of the capture requestor. |
+------------------+--------------------------------------------------+
| RUserId | The userid of the capture requestor. |
+------------------+--------------------------------------------------+
| RTaskId | The taskid of the capture requestor. |
+------------------+--------------------------------------------------+
| CAsid | The ASID of the capture task. |
+------------------+--------------------------------------------------+
| CJobName | The jobname of the capture task. |
+------------------+--------------------------------------------------+
| CJobId | The jobid of the capture task. |
+------------------+--------------------------------------------------+
| CmdCt | The count of command displays captured in the |
| | capture data set. |
+------------------+--------------------------------------------------+
| BlkCt | The total number of blocks written to the |
| | capture data set. |
+------------------+--------------------------------------------------+
| CmpRt | The compression rate of the capture data set. |
+------------------+--------------------------------------------------+
| CmpCt | A count of capture data set blocks saved due to |
| | compression. |
+------------------+--------------------------------------------------+
| Rc | The capture task return code. |
+------------------+--------------------------------------------------+
| Rs | The capture task reason code. |
+------------------+--------------------------------------------------+
| ErrCode1 | Specifies capture task error code 1. |
+------------------+--------------------------------------------------+
| ErrCode2 | Specifies capture task error code 2. |
+------------------+--------------------------------------------------+
| AbnCode | The capture task abend completion code. |
+------------------+--------------------------------------------------+
| Rels | The product release of the capture task that |
| | created the capture data set. |
+------------------+--------------------------------------------------+
| Bld | The product build number of the capture task |
| | that created the capture data set. |
+------------------+--------------------------------------------------+
| CapDsname | The capture data set name. |
+------------------+--------------------------------------------------+
| CapVol | The capture data set volser. |
+------------------+--------------------------------------------------+
| IdxDsname | The capture index data set name. |
+------------------+--------------------------------------------------+
| CaseNum | The case number. |
+------------------+--------------------------------------------------+
| SiteId | The site identifier. |
+------------------+--------------------------------------------------+
| SiteName | The site name. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| CLEanup | Requests a cleanup action against the index record and |
| | capture data set. Cleanup does the following: |
| | |
| | - If the capture data set is not cataloged, then the |
| | index record is erased. |
| | - If the capture data set is cataloged and is expired, |
| | then the capture data set is deleted and the index |
| | record is erased. If the delete fails, then the |
| | erase is not attempted. |
| | - If the capture data set is cataloged and is not |
| | expired, then nothing is done. |
| | |
+----------+----------------------------------------------------------+
| DELete | Requests that the capture data set be deleted. The |
| | capture data set is deleted if it exists. The index |
| | record is not affected. |
+----------+----------------------------------------------------------+
| Edit | Invokes the ISPF EDIT command for the selected capture |
| | data set. This is only valid when ISPF services are |
| | available. |
+----------+----------------------------------------------------------+
| ERAse | Requests that the index record be erased. The index |
| | record is erased regardless of the state of the capture |
| | data set to which it points. The capture data set is |
| | not affected. |
+----------+----------------------------------------------------------+
| FTPCA | Invokes the FTPCA command to FTP the selected capture |
| | data set to Technical Support. |
+----------+----------------------------------------------------------+
| PURge | Requests that the capture data set be deleted and that |
| | the index record be erased. PURGE is a combination of |
| | the DELETE and ERASE line commands listed above. |
+----------+----------------------------------------------------------+
| Zap | Invokes the ZAP command for the selected capture data |
| | set. |
+----------+----------------------------------------------------------+
| ZRO | Invokes the ZAP command with the READONLY option for |
| | the selected capture data set. |
+----------+----------------------------------------------------------+
| ZRW | Invokes the ZAP command with the READWRITE option for |
| | the selected capture data set. |
+----------+----------------------------------------------------------+

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Select | Invokes the CAPEVENT command to list the contents of the |
| | selected capture data set. |
+----------+----------------------------------------------------------+
| Note | Invokes the CAPNOTE command for the selected capture |
| | data set. |
+----------+----------------------------------------------------------+
| DSinfo | Invokes the DSINFO command to display information about |
| Info | the selected capture data set. |
+----------+----------------------------------------------------------+
| LISTCat | Invokes the IDCAMS command to execute a LISTCAT against |
| LCat | the selected capture data set. |
+----------+----------------------------------------------------------+
| LCIndex | Invokes the IDCAMS command to execute a LISTCAT against |
| | the selected capture index dataset. |
+----------+----------------------------------------------------------+
| IDent | Invokes the capture index record detail display that |
| | includes the following information: |
| | |
| | Capture data set |
| | Dsname |
| | Volser |
| | Creation date |
| | Creation time |
| | Expiration date |
| | Release |
| | Build |
| | Capture data version |
| | Format version |
| | Data record prefix version |
| | Caplib data set |
| | Dsname |
| | Volser |
| | Member |
| | Parameters |
| | Capture |
| | Site name |
| | Site id |
| | Case number |
| | Description |
| | System name |
| | Return code |
| | Reason code |
| | Error codes |
| | Error code 1 |
| | Error code 2 |
| | Abend code |
| | Command count |
| | Block count |
| | Blocks saved |
| | Requested by |
| | JobName |
| | JobId |
| | Asid |
| | UserId |
| | TaskId |
| | Captured by |
| | JobName |
| | JobId |
| | Asid |
| | |
+----------+----------------------------------------------------------+
| Browse | Invokes the ISPF BROWSE command for the selected capture |
| | data set. This is only valid when ISPF services are |
| | available. |
+----------+----------------------------------------------------------+
| View | Invokes the ISPF VIEW command for the selected capture |
| | data set. This is only valid when ISPF services are |
| | available. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFresh | Refreshes the display data. Note that REFRESH refreshes |
| | the CAPMAINT display for any active SELECT or SORT |
| | command but does not re-read the capture index data |
| | sets. To re-read the capture index data sets, you must |
| | either reissue the CAPMAINT command with the same |
| | parameters or issue the REBUILD command listed below. |
+----------+----------------------------------------------------------+
| REBuild | Rebuilds the display data. The REBUILD command re-reads |
| | the current capture index data sets. It is the same as |
| | reissuing the CAPMAINT command with the same parameters |
| | as originally entered. |
+----------+----------------------------------------------------------+
| OPTions | Set and display CAPMAINT command options. |
+----------+----------------------------------------------------------+
| CLEanup | Performs cleanup maintenance against all currently |
| | displayed index records and the capture data sets they |
| | represent. For more information on the CLEANUP command, |
| | see below. |
+----------+----------------------------------------------------------+
| SUMmary | Displays a summary report of the CLEANUP subcommand |
| | actions. This is not valid if no CLEANUP command has |
| | been executed. |
+----------+----------------------------------------------------------+
| DETails | Displays a detail report of the CLEANUP subcommand |
| | actions. This is not valid if no CLEANUP command has |
| | been executed. |
+----------+----------------------------------------------------------+
| IMPort | Imports a capture data set into a capture index. |
+----------+----------------------------------------------------------+

OPTIONS Subcommand
The OPTIONS subcommand is used to set and display
CAPMAINT command processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [optns] |
+---------------+-----------------------------------------------------+

The following table lists and explains the valid


OPTIONS parameter values. Any number of the values
can be specified in any order. The current settings
of all options are always displayed in response to
the OPTIONS subcommand.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| Dsname | Sets the default option to be used when the |
| Hlqual | CAPMAINT command is entered with no parameters. |
| | The initial default is DSNAME. |
+---------------+-----------------------------------------------------+
| System | Sets the default option to be used then the |
| User | CAPMAINT command is entered with no parameters. |
| | The initial default is SYSTEM. |
+---------------+-----------------------------------------------------+
| Confirm | Controls whether you are prompted to confirm |
| NOConfirm | CLEANUP commands, and CLEANUP, ERASE, DELETE, |
| | and PURGE line commands. The initial default |
| | is CONFIRM. |
+---------------+-----------------------------------------------------+
| DElete | Controls whether the CLEANUP subcommand and line |
| NODElete | command should delete expired capture data sets. |
| | The initial default is DELETE. |
+---------------+-----------------------------------------------------+
| Simulate | Controls whether the CLEANUP subcommand executes |
| NOSimulate | in simulate mode. In simulate mode, no capture |
| | data sets are actually deleted and no capture |
| | index records are actually erased. The initial |
| | default is NOSIMULATE. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_CAPMAINT. This keyword is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. EXTRACT can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+---------------+-----------------------------------------------------+

CLEANUP Subcommand

The CLEANUP subcommand requests a cleanup action


against all currently displayed index records and
the capture data sets they point to. Cleanup does
the following:

- If the capture data set is not cataloged,


then the index record is erased.
- If the capture data set is cataloged and is
expired, then the capture data set is deleted
and the index record is erased. If the delete
fails, then the erase is not attempted. If the
NODELETE option was specified or defaulted to,
then the delete is skipped and the erase is
not attempted.

- If the capture data set is cataloged and is


not expired, then no action is taken.

After the CLEANUP command completes, the SUMMARY and


DETAILS subcommands are available to view a summary
or detail report of the cleanup actions.

CLEANUP Subcommand Format

+---------------+-----------------------------------------------------+
| CLEanup | [options] |
+---------------+-----------------------------------------------------+

The following table lists and explains the valid


CLEANUP options parameter values. Any number of the
values can be specified in any order. The initial
default values for each option are listed but these
defaults may have be changed by the CAPMAINT OPTIONS
subcommand.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| Confirm | Controls whether you are prompted to confirm the |
| NOConfirm | CLEANUP subcommand. The initial default is CONFIRM. |
+---------------+-----------------------------------------------------+
| DElete | Controls whether CLEANUP should delete expired |
| NODElete | capture data sets. The initial default is DELETE. |
+---------------+-----------------------------------------------------+
| Simulate | Controls whether CLEANUP executes in simulate mode. |
| NOSimulate | In simulate mode, no capture data sets are deleted |
| | and no index records are erased. The initial |
| | default is NOSIMULATE. |
+---------------+-----------------------------------------------------+

SUMMARY Subcommand

The SUMMARY subcommand displays a summary report of


the results of a previously executed CLEANUP command.
The SUMMARY subcommand is not valid if no CLEANUP
subcommand has been executed or if a REBUILD subcommand
has been issued since the last CLEANUP subcommand.

SUMMARY Subcommand Format

+---------------+-----------------------------------------------------+
| SUMmary | |
+---------------+-----------------------------------------------------+

The SUMMARY subcommand has no parameters.

DETAIL Subcommand
The DETAILS subcommand displays a detailed report of
the results of a previously executed CLEANUP command.
The SUMMARY subcommand is not valid if no CLEANUP
subcommand has been executed or if a REBUILD subcommand
has has been issued since the last CLEANUP subcommand.

DETAILS Subcommand Format

+---------------+-----------------------------------------------------+
| DETails | |
+---------------+-----------------------------------------------------+

The DETAILS subcommand has no parameters.

IMPORT Subcommand

The IMPORT subcommand imports a capture data set into


a capture index. All of the information required for
a new capture index record is contained in the capture
data set itself.

IMPORT Subcommand Format

+---------------+-----------------------------------------------------+
| IMPort | capdsn [idxdsn] |
+---------------+-----------------------------------------------------+

IMPORT Subcommand Parameters

+---------------+-----------------------------------------------------+
| Parameter | Description |
+---------------+-----------------------------------------------------+
| capdsn | The name of the capture dataset you wish to import. |
| | The data set must be cataloged. |
+---------------+-----------------------------------------------------+
| idxdsn | The name of the index data set into which you want |
| | to import the new record. If CAPMAINT is currently |
| | displaying a specific capture index data set, then |
| | that index data set name is used as the default if |
| | the IDXDSN parameter is omitted. If generic index |
| | data set names are currently displayed (even if |
| | there was only one match), then the IDXDSN |
| | parameter is required. |
+---------------+-----------------------------------------------------+

IMPORT Subcommand Notes

1. Once the IMPORT is complete, you must issue


a REBUILD subcommand to see the new index
record that was just added.

2. The expiration date of an imported data set


is set to PERM. To alter this date, issue the
REBUILD subcommand so that the new record is
visible and then overtype the ExpDate field
with the desired expiration date.
CAPNOTE

CAPNOTE Command

The CAPNOTE command is used to view or edit notes saved


with a capture data set.

For information about the Event Capture Option, follow this


hyperlink to the Event Capture Option help topic.

For additional information about other Event Capture commands,


follow this hyperlink to an Event Capture Command Summary.

Command Syntax

+---------------+-----------------------------------------------------+
| CAPNOTE | [*|capdsn] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| * | Requests the capture data set currently opened |
| | to your session with the CAPOPEN command. |
| | This is the default if the parameter is omitted. |
+------------------+--------------------------------------------------+
| capdsn | The name of the capture dataset whose note |
| | you would like to view or edit. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| |
| The following fields are displayed for a capture dataset |
| currently open to your session. |
| |
+------------------+--------------------------------------------------+
| Capture | The capture data set status - OPEN or CLOSED. |
+------------------+--------------------------------------------------+
| Descr | The description of the capture data set. |
+------------------+--------------------------------------------------+
| ALT | The value "ALT" is displayed when the note data |
| | has been altered. |
+------------------+--------------------------------------------------+
| Command | The name of the command last captured. |
+------------------+--------------------------------------------------+
| Title | The display title of the command last captured. |
+------------------+--------------------------------------------------+
| |
| The following fields are displayed for a specific capture |
| data set name. |
| |
+------------------+--------------------------------------------------+
| Dsname | The capture data set name. |
+------------------+--------------------------------------------------+
| Volser | The capture data set volser. |
+------------------+--------------------------------------------------+
| ALT | The value "ALT" is displayed when the note data |
| | has been altered. |
+------------------+--------------------------------------------------+
| Descr | The capture description. |
+------------------+--------------------------------------------------+
| Member | The CAPLIB member name. |
+------------------+--------------------------------------------------+
| System | The name of the system on which the capture data |
| | set was created. |
+------------------+--------------------------------------------------+
| JobName | The jobname of the job that requested the |
| | capture. |
+------------------+--------------------------------------------------+
| Asid | The ASID of the job that requested the capture. |
+------------------+--------------------------------------------------+
| UserId | The userid that requested the capture. |
+------------------+--------------------------------------------------+
| TaskId | The taskid that requested the capture. |
+------------------+--------------------------------------------------+
| Created | The date and time the capture data set was |
| | created. |
+------------------+--------------------------------------------------+
| Expires | The expiration date of the capture data set. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Text | The text of the note. |
+------------------+--------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| CANcel | Exit from CAPNOTE without saving any changes. |
+----------+----------------------------------------------------------+
| CLEar | Clear the displayed notes to blanks. |
+----------+----------------------------------------------------------+
| SAVe | Save any changes made to the capture data set. |
+----------+----------------------------------------------------------+
| REStore | Restore the note data that existed after the last SAVE. |
+----------+----------------------------------------------------------+
CAPOPEN

CAPOPEN Command

The CAPOPEN command is used to open a capture data set


to your session. Once you have an open capture data set
you can use the CAPIMMED command to capture command data
to your opened capture data set. After you are done
capturing data you should issue the CAPCLOSE command to
close your capture dataset and update your capture index.
If a capture data set is open at session termination it
will be closed automatically.

For information about the Event Capture Option, follow this


hyperlink to the Event Capture Option help topic.

For additional information about other Event Capture commands,


follow this hyperlink to an Event Capture Command Summary.

Command Syntax

+---------------+-----------------------------------------------------+
| CAPOPEN | [optns] |
+---------------+-----------------------------------------------------+

Parameters

The following table lists and explains the valid


CAPOPEN [optns] values.

+-------------------+-------------------------------------------------+
| Parameter | Description |
+-------------------+-------------------------------------------------+
| User|System | Specifies whether the user or system capture |
| | data set high-level qualifier and capture index |
| | data set names are to be used. The default is |
| | USER. The user and system capture data set |
| | high-level qualifier and data set name are |
| | displayed by the CAPPARMS command. You can |
| | change your own user values with these two |
| | commands but you can only view the system |
| | values. |
+-------------------+-------------------------------------------------+
| Descr string | Specifies the description to be associated with |
| | the captured event. This description overrides |
| | any description supplied by a CAPPARMS DESCR |
| | command. The description can be any string |
| | of characters from 1 to 48 characters long. |
| | If the string contains blanks or commas, then |
| | it must be enclosed in character delimiter |
| | characters. If it contains lowercase |
| | characters, then the CHARS string qualifier |
| | must also be used: |
| | |
| | DESCR c'lowercase preserved' |
| | |
+-------------------+-------------------------------------------------+
| Msg | Controls whether or not the "Capture opened" |
| NOMsg | informational message is displayed. The default |
| | is MSG. Warning and error messages are always |
| | displayed. |
+-------------------+-------------------------------------------------+
CAPPARMS

CAPPARMS Command

The CAPPARMS command is used to set or modify capture


parameters.

For information about the Event Capture Option, follow this


hyperlink to the Event Capture Option help topic.

For additional information about other Event Capture commands,


follow this hyperlink to an Event Capture Command Summary.

Command Syntax

The following command format is used to modify one or


more capture parameter values using a command-line
interface. This is the form that must be used in a
scheduled capture CAPLIB member.

The default parameters for a scheduled capture are


taken from the CAPTURE PARMLIB member. One or more
CAPPARMS commands in a CAPLIB member can be used to
override those defaults. With the exception of the
LISTLOG keyword, any CAPPARMS commands and keyword
in a CAPLIB member must precede the first CAPTURE
command in the member. Any found after the first
CAPTURE command are ignored.

+---------------+-----------------------------------------------------+
| CAPPARMS | keyword value [keyword value] [keyword value] ... |
+---------------+-----------------------------------------------------+

The following command format resets all capture


parameter values to their defaults.

+---------------+-----------------------------------------------------+
| CAPPARMS | DEFAULTS |
+---------------+-----------------------------------------------------+

The following command format invokes a fullscreen


display of all capture parameters and their values.
The fullscreen display allows the values to be
modified by overtyping the current value.

+---------------+-----------------------------------------------------+
| CAPPARMS | |
+---------------+-----------------------------------------------------+

Parameters

The following table lists and explains the valid


CAPPARMS [keyword value] parameters. Any number of
[keyword value] pairs can be entered or multiple
CAPPARMS commands can be entered. Duplicate keywords
may be specified. The last value supplied is used.
Any keyword not explicitly coded is not changed.

+-------------------+-------------------------------------------------+
| keyword value | Description |
+-------------------+-------------------------------------------------+
| IDXDSN string | Specifies the capture index data set name. |
+-------------------+-------------------------------------------------+
| IDXHLQ string | Specifies the capture index dataset name |
| | high-level qualifier. |
+-------------------+-------------------------------------------------+
| HLQUAL hlqual | Specifies the capture data set name high-level |
| | qualifier. Time and date nodes are appended to |
| | this value to ensure a unique data set name: |
| | |
| | The maximum length of the hlqual is 28 to allow |
| | room for the time and date qualifiers. |
| | |
| | hlqual length [= 27 : hlqual.Thhmmsst.Dyymmdd |
| | hlqual length = 28 : hlqual.Thhmmss.Dyymmdd |
| | |
+-------------------+-------------------------------------------------+
| TYPE kwd | The capture data set space allocation type. |
| | Valid values for kwd are: |
| | |
| | BLKS Allocation is in blocks where the |
| | block size is 4096 |
| | TRKS Allocation is in tracks |
| | CYLS Allocation is in cylinders |
+-------------------+-------------------------------------------------+
| PRIMARY number | The capture data set space allocation primary |
| | quantity. The value must be a number from 0 |
| | to 999999. Unused space is always released. |
+-------------------+-------------------------------------------------+
| SECONDARY number | The capture data set space allocation |
| | secondary quantity. The value must be a number |
| | from 1 to 999999. Unused space is always |
| | released. |
+-------------------+-------------------------------------------------+
| CONTIG kwd | Specifies whether contiguous space should be |
| | allocated. Values for kwd are YES and NO. |
+-------------------+-------------------------------------------------+
| ROUND kwd | Specifies whether a partial cylinder allocation |
| | should be rounded up to a full cylinder. This |
| | parameter only applies to allocation types or |
| | BLKS or TRKS. Values for kwd are YES and NO. |
+-------------------+-------------------------------------------------+
| RETENTION number | The number of days that the capture data set is |
| | retained before being deleted. The value must |
| | be a number from 0 to 9999. A keyword of PERM |
| | can be specified to indicate that the capture |
| | data set is never to be deleted. A keyword of |
| | NONE can also be specified. NONE is the same |
| | as 0. |
+-------------------+-------------------------------------------------+
| DATACLASS string | The capture data set allocation SMS data class |
| | name. This value can be any valid SMS data |
| | class name or the keyword NONE. |
+-------------------+-------------------------------------------------+
| STORCLASS string | The capture data set allocation SMS storage |
| | class name. This value can be any valid SMS |
| | storage class name or the keyword NONE. |
+-------------------+-------------------------------------------------+
| MGMTCLASS string | The capture data set allocation SMS management |
| | class name. This value can be any valid SMS |
| | management class name or the keyword NONE. |
+-------------------+-------------------------------------------------+
| UNIT string | The capture data set allocation unit name. |
| | This value can be any valid unit name or the |
| | keyword NONE. |
+-------------------+-------------------------------------------------+
| VOLSER string | The capture data set allocation volume serial |
| | number. This value can be any valid volume |
| | serial number or the keyword NONE. |
+-------------------+-------------------------------------------------+
| DESCR string | Specifies the default description for a capture |
| | data set. This description can be overridden |
| | by a CAPTURE, CAPOPEN, CAPIMMED, or CAPCLOSE |
| | command. It can also be modified by overtyping |
| | the Descr field on the CAPMAINT display. |
| | The description string can be any string of |
| | characters from 1 to 48 characters long. If |
| | the string contains blanks or commas, then it |
| | must be enclosed in character delimiters |
| | characters. If it contains lowercase |
| | characters, then the CHARS string qualifier |
| | must also be used: |
| | |
| | DESCR c'lowercase preserved' |
| | |
+-------------------+-------------------------------------------------+
| LISTLOG kwd | This option controls the conditions under a |
| | LISTLOG command should be executed and its |
| | output captured at the termination of a |
| | scheduled CAPLIB member. The LISTLOG output |
| | can useful in debugging errors that occur when |
| | running the CAPLIB member. Values for this |
| | keyword can be |
| | |
| | ALways Always capture LISTLOG output. |
| | |
| | Warning Capture LISTLOG output only when |
| | the CAPLIB member ended with a |
| | warning (or higher) condition. |
| | |
| | Error Capture LISTLOG output only when |
| | the CAPLIB member ended with an |
| | error (or higher) condition. |
| | |
| | ABend Capture LISTLOG output only when |
| | when the CAPLIB member ended with |
| | an abend condition. |
| | |
| | Never Never capture LISTLOG output. |
| | |
| | The default is ERROR. The value specified on |
| | the CAPPARMS command overrides the default |
| | specified at initialization time by the ListLog |
| | parameter in the CAPTURE PARMLIB member. The |
| | override in only used in the CAPLIB member in |
| | which it was specified. |
| | |
| | The LISTLOG keyword is only valid in a CAPLIB |
| | member. It is processed but ignored in all |
| | other interfaces. |
| | |
| | Note that if the last command captured in a |
| | CAPLIB member is a LISTLOG command the |
| | CAPPARMS LISTLOG option or CAPTURE PARMLIB |
| | ListLog option is ignored. |
| | |
+-------------------+-------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Type | The type of capture parameter. The Type values |
| | can be: |
| | |
| | USER User parameters. These are the |
| | parameters used for the immediate |
| | capture process using the CAPOPEN, |
| | CAPIMMED, and CAPCLOSE commands. |
| | These parameters are modifiable. |
| | |
| | SYS System parametes. These are the |
| | parameters used for the scheduled |
| | capture process. These parameters |
| | are taken from the CAPTURE PARMLIB |
| | member and are not modifiable. |
| | |
+------------------+--------------------------------------------------+
| Description | A description of the parameter. |
+------------------+--------------------------------------------------+
| Keyword | The parameter keyword. The possible keywords |
| | are listed above in the Parameters section. |
+------------------+--------------------------------------------------+
| Value | The parameter value. The USER parameter values |
| | can be modified by overtyping. Valid values |
| | are described above in the Parameters section. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
| CANCEL | Exits the CAPPARMS command without making any changes. |
+----------+----------------------------------------------------------+
| DEFAULTS | Resets all capture parameters to their default values. |
+----------+----------------------------------------------------------+
CAPQUERY

CAPQUERY Command

The CAPQUERY command is used to display the state of


the capture data set that may be allocated to your
session. The state of OPEN or CLOSE will be displayed
in a message in response the CAPQUERY command.

For information about the Event Capture Option, follow this


hyperlink to the Event Capture Option help topic.

For additional information about other Event Capture commands,


follow this hyperlink to an Event Capture Command Summary.

Command Syntax

+---------------+-----------------------------------------------------+
| CAPQUERY | |
+---------------+-----------------------------------------------------+

Parameters

This command has no parameters.


CAPTURE

CAPTURE Command

The CAPTURE command is used to request an event capture.

An event capture is a collection of one or more commands whose output


is stored in an output data set for review at some future time.

Commands may be scheduled to be collected asynchronously by a


server task running in the user address space, or synchronously during
an interactive user session.

For scheduled captures, the name of a member, which contains the list
of commands to be captured, is specified. The only commands that are
captured are the ones that are followed by a CAPTURE command.
The member may come from a CAPLIB data set or from a data set name
specified as a parameter.

For interactive captures, the CAPTURE command has options, specified


below, to capture individual commands during the session.

For information about the Event Capture Option, follow this


hyperlink to the Event Capture Option help topic.

For additional information about other Event Capture commands,


follow this hyperlink to an Event Capture Command Summary.

Command Syntax

The following command format is used to request the scheduling of a


capture member to be queued for execution by a SYSVIEW server task.

+---------------+-----------------------------------------------------+
| CAPTURE | member | dsname(member) |
| | |
| | [ Descr desc ] |
| | |
| | [ Wait|NOWait ] |
| | ------ |
| | |
| | [ Parms p1 p2 ... ] |
+---------------+-----------------------------------------------------+

The following command format is used within a capture member to capture


the current command display during a scheduled capture execution.
See note 1 in the Notes section below for an example.

+---------------+-----------------------------------------------------+
| CAPTURE | [ Title string ] |
+---------------+-----------------------------------------------------+

For interactive sessions, the following CAPTURE command syntax can be


used. There are equivalent primary commands that perform the same
functions. See the parameter help for more details.
+---------------+-----------------------------------------------------+
| CAPTURE | Open | |
| | Immediate | |
| | Close | |
| | Query |
| | |
| | [options] |
| | |
+---------------+-----------------------------------------------------+

Parameters

+--------------+------------------------------------------------------+
| Parameter | Description |
+--------------+------------------------------------------------------+
| member | The name of the capture member to be scheduled. |
| | |
| | See Security note 1 for controlling access. |
+--------------+------------------------------------------------------+
| dsname | Specifies the optional data set name of the library |
| | containing the capture member. |
| | |
| | The data set name can be specified as a fully |
| | qualified data set by enclosing it in character |
| | delimiters. |
| | |
| | If you omit the character delimiters, then your data |
| | set name prefix is left appended to the data set |
| | name. |
| | |
| | Data set name can be specified using one of the |
| | following special keywords: |
| | |
| | |
| | Keyword Description |
| | ---------- ------------------------------------- |
| | USER Use the optional data set name |
| | defined in the user profile for the |
| | CAPLIB keyword. |
| | |
| | Example: USER(member) |
| | |
| | SITE Use the optional CAPLIB site data |
| | set that is defined in the system |
| | configuration options parmlib |
| | member: GSVXSYSV |
| | |
| | Example: SITE(member) |
| | |
| | SYSTEM Use the CAPLIB system data set that |
| | is defined in the system |
| | configuration options parmlib |
| | member: GSVXSYSV |
| | |
| | Example: SYSTEM(member) |
| | |
| | SITESYSTEM Concatentate the following data sets |
| | SITE.SYSTEM to search for the specified member |
| | * name: |
| | |
| | * Optional CAPLIB site data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXSYSV |
| | |
| | * The CAPLIB system data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXSYSV |
| | |
| | Example: SITESYSTEM(member) |
| | SITE.SYSTEM(member) |
| | *(member) |
| | |
| | USERSITE Concatentate the following |
| | USER.SITE data sets to search for the |
| | specified member name: |
| | |
| | * Optional data set name defined |
| | in the user profile for the |
| | CAPLIB keyword. |
| | |
| | * Optional CAPLIB site data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXSYSV |
| | |
| | Example: USERSITE(member) |
| | USER.SITE(member) |
| | |
| | USERSYSTEM Concatentate the following data sets |
| | USER.SYSTEM to search for the specified member |
| | name: |
| | |
| | * Optional data set name defined in |
| | the user profile for the CAPLIB |
| | keyword. |
| | |
| | * The CAPLIB system data set that is |
| | defined in the system configuration |
| | options parmlib member: GSVXSYSV |
| | |
| | Example: USERSYSTEM(member) |
| | USER.SYSTEM(member) |
| | |
| | The above keywords can be cursor selected |
| | invoking a hyperlink to the LIBS command showing |
| | the available data sets for the keyword. |
| | |
| | See Security note 1 for controlling access. |
+--------------+------------------------------------------------------+
| Wait | Specifies that you want to wait for the completion |
| | of your capture request. |
+--------------+------------------------------------------------------+
| NOWait | Specifies that you do not want to wait for the |
| | completion of your capture request. |
| | This is the default. |
+--------------+------------------------------------------------------+
| Descr | Specifies the description to be associated with the |
| | captured event. This description overrides any |
| | description supplied by a CAPPARMS DESCR command |
| | within the CAPLIB member. The description string can |
| | be any string of characters from 1 to 48 characters |
| | long. If the string contains blanks or commas, then |
| | it must be enclosed in character delimiters. If it |
| | contains lowercase characters, then the CHARS string |
| | qualifier must also be used: |
| | |
| | DESCR c'lowercase preserved' |
| | |
+--------------+------------------------------------------------------+
| Parms | Specifies one or more parameters to be passed to the |
| | CAPLIB member. The PARMS keyword is optional. If it |
| | is omitted, then the first unrecognized CAPTURE |
| | command parameter is assumed to be the start of the |
| | parameters to be passed to the CAPLIB member. The |
| | parameters, once recognized, are assumed to extend |
| | to the end of CAPTURE command string. Any paraemter |
| | that contains blanks or commas must be enclosed in |
| | character delimiters. The parameters are passed as |
| | command variables named &1, &2, ... for as many |
| | parameters as you specify. If you omit a parameter |
| | by specifying two consecutive commas, then that has |
| | a null value. The commands in the CAPLIB member can |
| | refer to these variables or to any other command |
| | variables defined by the VDEFINE command. See the |
| | VDEFINE command for information on defining |
| | variables. See the VLIST command for information on |
| | displaying the defined variables and their current |
| | values. |
+--------------+------------------------------------------------------+
| Title | Specifies the title to be associated with the |
| | captured event. This title overrides the command |
| | screen title and is displayed in the Title field on |
| | the CAPEVENT command display. The title can be any |
| | string of characters from 1 to 48 characters long. |
| | If the string contains blanks or commas it must be |
| | enclosed in character delimiters. If it contains |
| | lowercase characters, then the CHARS string |
| | qualifier must also be used: |
| | |
| | TITLE c'lowercase preserved' |
| | |
+--------------+------------------------------------------------------+
| Open | Open a new capture event data set for your session. |
| | |
| | See the CAPOPEN command for details and a |
| | description of the allowed [options]. |
| | |
| | See Security note 2 for security access. |
+--------------+------------------------------------------------------+
| Immediate | Capture the current command's display data to the |
| | open capture data set. |
| | |
| | See the CAPIMMED command for details and a |
| | description of the allowed [options]. |
| | |
| | See Security note 2 for security access. |
+--------------+------------------------------------------------------+
| Close | Close the open capture data set. |
| | |
| | See the CAPCLOSE command for details and a |
| | description of the allowed [options]. |
| | |
| | See Security note 2 for security access. |
+--------------+------------------------------------------------------+
| Query | Display the state of the session capture data set. |
| | See the CAPQUERY command for details and a |
| | description of the allowed [options]. |
+--------------+------------------------------------------------------+
Notes

1. This is a sample event capture member showing the use of the CAPTURE
command to capture specific displays:

* This is just a sample comment.


* Comments start in column 1 using an *.
ACTIVITY
CAPTURE [=== The ACTIVITY display will be captured

CICSLIST ; CAPTURE [=== The CICSLIST command will be captured

VSMTRACK SUMMARY
SORT TOTAL D
CAPTURE [=== The sorted VSMTRACK display will be
captured.

Security Requirements

1. Subcommand security is used to verify the access to capture events


based on the location of the event:

Subcommand Description
---------- -------------------------------------------------------
SYSTEM When the member is found in the SYSTEM CAPLIB, the
SYSTEM subcommand is checked to determine if the user
is allowed to execute the capture event member.

SITE When the member is found in the SITE CAPLIB, the


SITE subcommand is checked to determine if the user
is allowed to execute the capture event member.

USER When the member is found in the USER CAPLIB or it is


found in the specified external data set, the USER
subcommand is checked to determine if the user is
allowed to execute the capture event member.

Note: if the data set is explicitely requested, and


and the data set name is the SYSTEM or SITE library
name, then the corresponding SYSTEM or SITE subcommand
check is done.

Also, the user capture event will be executed under


userid that requested the event, so it is still
subject to all other command security checks.

The USER subcommand check is also performed for the


/POST CAPTURE REST API endpoint.

2. The immediate functions of Open, Immediate, and Close are checked


using command security for CAPOPEN, CAPIMMED, and CAPCLOSE
respectively.

For example, if one does not have access to command CAPOPEN,


then the CAPTURE Open function will fail.
CARTM

CARTM Command

The CARTM command displays information about transactions processed


by the ARTM (automated response time management) function.

Target response times can be maintained here (warm start) or in


parmlib member CICSARTM (cold start). Transaction names can only
be added manually by using the parmlib member, or dynamically via
the ARTM-DYNAMIC-ADD configuration option in the SVWCOPTS parmlib
member.

Automated Response Time Management will dynamically adjust the


priority of a transaction in order to meet the specified response
time goal by that transaction. Each transaction that is to be
controlled by ARTM must have a target response time and maximum
priority specified. The transaction's priority will be raised
and lowered to achieve the target response time.

Command Syntax

+------------------+--------------------------------------------------+
| CARTM | [ SAVE ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| SAVE | Save the definitions to the persistent data |
| | store. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| StartMode | Specifies the start mode at product |
| | initialization for the definitions. |
| | |
| | Possible values are: |
| | |
| | COLD - Definitions were obtained |
| | from parmlib members. |
| | |
| | WARM - Definitions were obtained |
| | from the persistent data store. |
| | If the data was not available in |
| | the persistent data store, the |
| | data will then be obtained from |
| | parmlib members. |
| | |
| | This value is initially set in parmlib member |
| | SVWCOPTS option ARTM-STARTTYPE but can be |
| | overridden at SYSVIEW startup. |
+------------------+--------------------------------------------------+
| Checkpoint | Indicates whether a checkpoint is needed to save |
| | modified definitions. |
| | |
| | Possible values are: |
| | |
| | SAVED - No checkpoint is needed. |
| | |
| | REQUIRED - Definitions have been changed. |
| | These changes have not been |
| | saved. |
+------------------+--------------------------------------------------+

Data Fields

An interval is defined as the time in which the average response time


of the transaction was above or below the targeted response time.

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Tran | The transaction name. |
+------------------+--------------------------------------------------+
| Target | The targeted response time. |
| | |
| | This field can be overtyped to alter the value. |
| | A transaction can be excluded from ARTM by |
| | entering a target response time of zero. |
+------------------+--------------------------------------------------+
| Count | The total count of transactions. |
+------------------+--------------------------------------------------+
| Avg-Resp | The average response time for the transaction. |
+------------------+--------------------------------------------------+
| WTR-Time | The average waiting to run time for the |
| | transaction. |
+------------------+--------------------------------------------------+
| ICount | The count of transactions during the interval. |
+------------------+--------------------------------------------------+
| Int-Resp | The average response time for the transaction |
| | during the last interval. |
+------------------+--------------------------------------------------+
| Int-WTR | The average waiting to run time for the |
| | transaction during the last interval. |
+------------------+--------------------------------------------------+
| TCount | The count of transactions during the interval |
| | that is being used to trigger a change in the |
| | priority. For more information, see |
| | configuration option ARTM-TRIGGER-COUNT in the |
| | SVWCOPTS parmlib member. |
+------------------+--------------------------------------------------+
| Pri | The current transaction priority. |
+------------------+--------------------------------------------------+
| Max | The maximum priority that ARTM is allowed to |
| | raise the priority. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| SAVE | Save the definitions to the persistent data |
| | store. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CARTM command security


CATALOG

CATALOG Command

The CATALOG command displays information about the CATALOG address space.
Line commands are provided that allow you to modify the status of catalogs
allocated to the CATALOG address space.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+---------------+-----------------------------------------------------+
| CATALOG | [options] |
+---------------+-----------------------------------------------------+

Parameters

The following table lists and explains the valid CATALOG options
parameter values. Any number of the values can be specified in any
order. The options specified on the CATALOG command are not saved
from one invocation of the CATALOG command to the next. Options
specified with the OPTIONS subcommand are saved in your profile.
These are then the defaults that the CATALOG options will override.
The defaults listed in the table below are the initial defaults.
Your default may be different if you have used the OPTIONS subcommand.

If you have tried various combinations of CATALOG command options


and have arrived at a set that you would like to save as your defaults,
you can enter the OPTIONS subcommand with no operands. This will save
the current set of options as your defaults.

+------------------+--------------------------------------------------+
| Value | Explanation |
+------------------+--------------------------------------------------+
| Info | Controls whether or not the info lines that |
| NOInfo | show catalog information will be displayed. |
| | The default is INFO. The data in these info |
| | rows is obtained from the responses to an OS |
| | "MODIFY CATALOG,REPORT" command. Issuing this |
| | command and processing the responses adds to |
| | the CPU and elapsed time for the CATALOG |
| | command. If you don't want or need this data, |
| | you should request the NOINFO option. |
+------------------+--------------------------------------------------+
| Ecshr | Controls whether or not an attempt is made to |
| NOEcshr | determine the ECSHR (ExtendedCatalogSHaring) |
| | status of a catalog. The default is ECSHR. |
| | This status is obtained from the responses to |
| | an OS "MODIFY CATALOG,ALLOCATED" command. |
| | Issuing this command and processing the |
| | responses adds to the CPU and elapsed time |
| | for the CATALOG comand. If you don't want or |
| | need this data, you should request the NOECSHR |
| | option. This option also controls the display |
| | of the Xtn% field value (the allocated extents |
| | percentage). |
+------------------+--------------------------------------------------+
| RESET | Resets all options to their initial default |
| | values. |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable.|
| | The variable created or updated is named |
| | SYSV_OPTIONS_CATALOG. This keyword is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. The EXTRACT keyword can be |
| | specified alone or in combination with any other |
| | OPTIONS keyword. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Options | Lists the current effective options. These |
| | options can be the original initial defaults, |
| | defaults overridden with the OPTIONS subcommand, |
| | or options specified on the CATALOG command. |
+------------------+--------------------------------------------------+
| The following info fields are not displayed when the NOINFO option |
| is in effect. They are also not displayed when "XSDATA YES" mode |
| is in effect. |
+------------------+--------------------------------------------------+
| Max open | The maximum number of open catalogs allowed. |
| catalogs | When XSDATA is YES this value is displayed in |
| | the data rows as field "MxOp". |
+------------------+--------------------------------------------------+
| Convert SYS%- | The SYS% to SYS1 conversion option. |
| SYS1 | Values are YES and NO. |
| | When XSDATA is YES this value is displayed in |
| | the data rows as field "Cvt". |
+------------------+--------------------------------------------------+
| Alias table | The multi-level alias table active option. |
| avail | Values are YES or NO. |
| | When XSDATA is YES this value is displayed in |
| | the data rows as field "MLA". |
+------------------+--------------------------------------------------+
| Alias levels | The number of alias levels specified. |
| | When XSDATA is YES this value is displayed in |
| | the data rows as field "Alv". |
+------------------+--------------------------------------------------+
| Service tasks | The current number of service tasks attached. |
| cur | When XSDATA is YES this value is displayed in |
| | the data rows as field "TCr". |
+------------------+--------------------------------------------------+
| Service tasks | The service tasks attached high water mark. |
| hwm | When XSDATA is YES this value is displayed in |
| | the data rows as field "THw". |
+------------------+--------------------------------------------------+
| Service tasks | The service tasks lower limit. |
| min | When XSDATA is YES this value is displayed in |
| | the data rows as field "TMn". |
+------------------+--------------------------------------------------+
| Service tasks | The service tasks upper limit. |
| max | When XSDATA is YES this value is displayed in |
| | the data rows as field "TMx". |
+------------------+--------------------------------------------------+
| Enabled | Enabled catalog features. For a list of the |
| | values that can be displayed in this field, |
| | refer to the description of IEC359I CATALOG |
| | REPORT OUTPUT message in the IBM System Messages |
| | Vol 7 (IEB-IEE) manual. |
| | When XSDATA is YES this data is not displayed. |
+------------------+--------------------------------------------------+
| Disabled | Disabled catalog features. For a list of the |
| | values that can be displayed in this field, |
| | refer to the description of IEC359I CATALOG |
| | REPORT OUTPUT message in the IBM System Messages |
| | Vol 7 (IEB_IEE) manual. |
| | When XSDATA is YES this data is not displayed. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Catalog-Name | The catalog data set name. |
+------------------+--------------------------------------------------+
| Volser | The volume serial number where the catalog |
| | resides. |
+------------------+--------------------------------------------------+
| Status | The catalog status. |
| | Possible values are: |
| | |
| | CLOSED Closed |
| | OPEN Open |
| | FREE Closed and freed |
| | DELETE Deleted |
| | -M Suffix on any of the above |
| | indicates the master catalog. |
| | DUMMY Dummy entry for Allocate line |
| | command. |
+------------------+--------------------------------------------------+
| Type | The catalog type. Types are ICF, VSAM, and VOL |
| | (tape volume catalog). |
+------------------+--------------------------------------------------+
| SMS | SMS if the catalog is SMS controlled. |
| | Otherwise, it is blank. |
+------------------+--------------------------------------------------+
| ISC | This value is ISC if the In-Storage Catalog |
| | facility is active for the catalog. This value |
| | is INV if the facility is active but invalidated.|
| | Otherwise, it is blank. |
+------------------+--------------------------------------------------+
| VLF | This value is VLF if the Virtual Lookaside |
| | Facility is active for the catalog. If VLF |
| | is inactive, then the value is blank. |
+------------------+--------------------------------------------------+
| SHR | This value is SHR if cross-system sharing is in |
| | in effect for the catalog. Otherwise it is blank.|
+------------------+--------------------------------------------------|
| ECS | This value is ECS if enhanced catalog sharing is |
| | in effect for the catalog. Otherwise it is blank.|
| | This field will also be blank if the NOESCHR |
| | option is in effect. This field may also display |
| | "n/f". This means "not found" and will occur |
| | when the responses to the OS "MODIFY CATALOG, |
| | ALLOCATED" command were truncated because the |
| | multi-line WTO limit was reached and not all |
| | catalogs were returned in the responses. |
+------------------+--------------------------------------------------+
| Lock | This value is LOCK if the catalog has been |
| | locked by an IDCAMS ALTER LOCK or IMPORT LOCK |
| | command. Otherwise, it is blank. |
+------------------+--------------------------------------------------+
| Use | The catalog activity count. |
+------------------+--------------------------------------------------+
| IO-Count | The number of I/Os to the catalog. |
+------------------+--------------------------------------------------+
| Hit% | The relative number of times a search of the |
| | cache found the requested record, expressed as |
| | a percentage. |
+------------------+--------------------------------------------------+
| RecCt | The number of records added to the cache. |
+------------------+--------------------------------------------------+
| SchCt | The number of times the cache was searched. |
+------------------+--------------------------------------------------+
| HitCt | The number of times a record was found in the |
| | cache. |
+------------------+--------------------------------------------------+
| DelCt | The number of records deleted from the cache. |
+------------------+--------------------------------------------------+
| ShrCt | The number of times the sharing protocol was |
| | effective in communicating changes made by |
| | sharing systems at the granularity of a catalog |
| | record. |
+------------------+--------------------------------------------------+
| InvCt | The number of times the entire cache for this |
| | catalog had to be invalidated. |
+------------------+--------------------------------------------------+
| Xtn% | The percentage of allocated extents for the |
| | catalog. This percentage indicates the extent |
| | usage by either the data or index component, |
| | whichever is higher. |
| | |
| | This field will be blank if the NOESCHR option |
| | is in effect. |
| | |
| | This field will display "n/a" if the allocated |
| | extents value is not available or not valid or |
| | the catalog status is CLOSED or DELETE. |
| | |
| | This field may also display "n/f" to indicate |
| | "not found". This may occur when the responses |
| | to the OS "MODIFY CATALOG,ALLOCATED" command |
| | were truncated because the multi-line WTO limit |
| | was reached and not all catalogs were returned |
| | in the responses. |
+------------------+--------------------------------------------------+
| CAXWA | The CAXWA address of the catalog. |
+------------------+--------------------------------------------------+
| The following fields are only displayed when XSDATA is YES. |
+------------------+--------------------------------------------------+
| MxOp | The maximum number of open catalogs allowed. |
| | When XSDATA is NO this value is displayed in |
| | the information section as "Max open catalogs". |
+------------------+--------------------------------------------------+
| Cvt | The SYS% to SYS1 conversion option. |
| | Values are YES and NO. |
| | When XSDATA is NO this value is displayed in |
| | the information section as "Convert SYS%-SYS1". |
+------------------+--------------------------------------------------+
| MLA | The multi-level alias table active option. |
| | Values are YES or NO. |
| | When XSDATA is NO this value is displayed in |
| | the information section as "Alias table avail". |
+------------------+--------------------------------------------------+
| ALv | The number of alias levels specified. |
| | When XSDATA is NO this value is displayed in |
| | the information section as "Alias levels". |
+------------------+--------------------------------------------------+
| TCr | The current number of service tasks attached. |
| | When XSDATA is NO this value is displayed in |
| | the information section as "Service tasks cur". |
+------------------+--------------------------------------------------+
| THw | The service tasks attached high water mark. |
| | When XSDATA is NO this value is displayed in |
| | the information section as "Service tasks hwm". |
+------------------+--------------------------------------------------+
| TMn | The service tasks lower limit. |
| | When XSDATA is NO this value is displayed in |
| | the information section as "Service tasks min". |
+------------------+--------------------------------------------------+
| TMx | The service tasks upper limit. |
| | When XSDATA is NO this value is displayed in |
| | the information section as "Service tasks max". |
+------------------+--------------------------------------------------+
XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Allocate | Allocates a previously created ICF catalog to |
| Alc | the catalog address space. This command is |
| | valid only from display lines where the status |
| | is DUMMY, FREE, or DELETE. On the DUMMY line, |
| | overtype the value in the Catalog-Name field |
| | with the name of the data set you want to |
| | allocate. On a line with a status of FREE or |
| | DELETE, the catalog in the Catalog-Name field |
| | is allocated. |
+------------------+--------------------------------------------------+
| Close | Closes an open ICF catalog without affecting |
| Cls | existing allocations. Use this command to |
| | dynamically change catalog attributes, such as |
| | share options and the number of strings. The |
| | catalog is closed and reopened with a new set |
| | of control blocks the next time a request is |
| | processed for the catalog. The rebuilding of |
| | the control blocks is transparent to the users |
| | of the catalog. |
+------------------+--------------------------------------------------+
| Free | Unallocates an open or closed ICF catalog from |
| Unalloc | the CATALOG address space. |
+------------------+--------------------------------------------------+
| Open | Opens a closed ICF catalog. |
| Opn | |
+------------------+--------------------------------------------------+
| VClose | Closes the VSAM volume data set (VVDS) for an |
| | open VSAM catalog without affecting existing |
| | allocations. The VVDS is reopened with a new |
| | set of control blocks the next time a request |
| | for it is processed. |
+------------------+--------------------------------------------------+
| ISC | Activates the In-Storage Catalog facility for |
| | an open ICF catalog. |
+------------------+--------------------------------------------------+
| NOIsc | Deactivates the In-Storage Catalog facility for |
| | an open ICF catalog. |
+------------------+--------------------------------------------------+
| VLF | Activates the catalog data space cache for an |
| | open ICF catalog. VLF must be active and have |
| | the catalog class IGGCAS defined and the catalog |
| | data set name as a major name. |
+------------------+--------------------------------------------------+
| NOVlf | Deactivates the catalog data space cache for an |
| | open ICF catalog. |
+------------------+--------------------------------------------------+
| ECShr | Issues a "MODIFY CATALOG,ECSHR(ENABLE,[dsname])" |
| | comand for the selected catalog. |
+------------------+--------------------------------------------------+
| NOECShr | Issues a "MODIFY CATALOG,ECSHR(REMOVE,[dsname])" |
| | comand for the selected catalog. |
+------------------+--------------------------------------------------+
| Zap | Invokes the ZAP command for the catalog. |
+------------------+--------------------------------------------------+
| ZRO | Invokes the ZAP command with the READONLY |
| | option. |
+------------------+--------------------------------------------------+
| ZRW | Invokes the ZAP command with the READWRITE |
| | option. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| DSinfo | Invokes the DSINFO command for the catalog |
| Info | data set. |
+------------------+--------------------------------------------------+
| LCat | Invokes the IDCAMS LISTCAT command to list the |
| LISTCat | catalog attributes. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| OPTIONS | Set CATALOG command options. |
+------------------+--------------------------------------------------+

OPTIONS Subcommand

The OPTIONS subcommand is used to set CATALOG command processing


options.

OPTIONS Subcommand Format

+------------------+--------------------------------------------------+
| OPTIONS | [options] |
+------------------+--------------------------------------------------+

The following table lists and explains the valid OPTIONS parameter
values. Any number of the values can be specified in any order.
The current settings of all options are always displayed in the
information area. Options changed with the OPTIONS subcommand
are saved in your profile as the default options for the CATALOG
command. These defaults can be overridden by specifying the same
option keywords on the CATALOG command. Options changed in this
manner are not saved.

+------------------+--------------------------------------------------+
| Value | Explanation |
+------------------+--------------------------------------------------+
| Info | Controls whether or not the info lines that |
| NOInfo | show catalog information will be displayed. |
| | The default is INFO. The data in these info |
| | rows is obtained from the responses to an OS |
| | "MODIFY CATALOG,REPORT" command. Issuing this |
| | command and processing the responses adds to |
| | the CPU and elapsed time for the CATALOG |
| | command. If you don't want or need this data, |
| | you should request the NOINFO option. |
+------------------+--------------------------------------------------+
| Ecshr | Controls whether or not an attempt is made to |
| NOEcshr | determine the ECSHR (ExtendedCatalogSHaring) |
| | status of a catalog. The default is ECSHR. |
| | This status is obtained from the responses to |
| | an OS "MODIFY CATALOG,ALLOCATED" command. |
| | Issuing this command and processing the |
| | responses adds to the CPU and elapsed time |
| | for the CATALOG comand. If you don't want or |
| | need this data, you should request the NOECSHR |
| | option. |
+------------------+--------------------------------------------------+
| RESET | Resets all options to their initial default |
| | values. |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable.|
| | The variable created or updated is named |
| | SYSV_OPTIONS_CATALOG. This keyword is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. The EXTRACT keyword can be |
| | specified alone or in combination with any other |
| | OPTIONS keyword. |
+------------------+--------------------------------------------------+

Messages

CTLG001E [linecmd] invalid for status [stat]

The [linecmd] line command is not valid for a catalog with status
[status].

CTLG002E [linecmd] invalid, catalog already using [option]

The ISC or VLF line command was issued for a catalog which already
had the ISC or VLF attribute.

CTLG003E [linecmd] invalid, catalog not using [option]

The NOISC or NOVLF line command was issued for a catalog which did
not have the ISC or VLF attribute.

CTLG004E [linecmd] invalid for type [cattype]

The [linecmd] line command is not valid for catalog [cattype].

CTLG005E ISC invalid for [dsname]

The ISC line command is not possible when the ISC status is INV.

CTLG006E Dataset name must be specified for ALLOCATE command

The ALLOCATE line command requires a catalog dataset name


when entered from the DUMMY status line. Overtype the
ALLOCATE.CATALOG.DSNAME value in the Catalog-Name field with
the name of the catalog to allocate.

CTLG007E Invalid dataset name

The catalog dataset name specified in the Catalog-Name field for


the ALLOCATE line command is not valid.

CTLG008E [dsname] is not cataloged

The dataset name specified with the ALLOCATE line command is not
cataloged.

CTLG009E [dsname] is not a catalog

The dataset name specified with the ALLOCATE line command is not a
catalog.

CTLG010E VLF invalid, VLF is not active

The VLF line command is not valid if VLF is inactive.

CTLG011E VLF invalid, class IGGCAS not defined to VLF


The VLF line command is not valid because the required catalog
class IGGCAS is not defined to VLF.

CTLG012E VLF invalid, catalog not defined to VLF

The VLF line command is not valid. The requested catalog name is
not defined to VLF.

CTLG013E COFIDENT failed, rc [rtncd] rs [rsncd]

The COFIDENT service failed.


Contact technical support.

CTLG014E [dsname] already allocated

The catalog dataset name supplied on the DUMMY line with the
ALLOCATE line command is already allocated to the catalog address
space.

CTLG015E Invalid "[fldname]" value found in "[cmd]" command output

The value found for the [fldname] field in the output of the
[cmd] command is not valid.

CTLG016I Catalog name [catname]

Informational only.

CTLG017E IGGCSI00 error, rc [rc] rs [rs] modid [modid]

Informational only.

CTLG018W IGGCSI00 warning, rc [rc] rs [rs] modid [modid]

Informational only.
CATOMS

CATOMS Command

The CATOMS command displays information about CICS Atom Service


resource definitions.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CATOMS | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+
Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Name,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Name | The name of the ATOMSERVICE |
+------------------+--------------------------------------------------+
| Status | Status indicator |
| | Possible values are: |
| | ENABLED |
| | DISABLED |
+------------------+--------------------------------------------------+
| AtomType | The Atom document type. |
| | Possible values are: |
| | CATEGORY - An Atom category lists the |
| | categories of documents in a |
| | collection |
| | COLLECT - An Atom collection contains a |
| | group of entry documents that |
| | can be edited |
| | FEED - An Atom Feed describes the |
| | metadata for a feed and contains |
| | entry documents that provide |
| | data for the feed |
| | SERVICE - An Atom services information about |
| | the collections of entry |
| | documents that are available |
| | on the server |
+------------------+--------------------------------------------------+
| RsceType | The CICS resource type that provides data for |
| | the Atom resource feed or collection. |
+------------------+--------------------------------------------------+
| Resource | The CICS resource that provides data for |
| | the Atom resource feed or collection. |
+------------------+--------------------------------------------------+
| ReferCnt | The number of times the Atom Service was |
| | located. |
+------------------+--------------------------------------------------+
| Disabled | The number of times the Atom Service was found |
| | disabled. |
+------------------+--------------------------------------------------+
| NonMatch | The number of times the path not matched. |
+------------------+--------------------------------------------------+
| PostFeed | The number of times a POST was issued for feed. |
+------------------+--------------------------------------------------+
| GetFeed | The number of times a GET was issued for feed. |
+------------------+--------------------------------------------------+
| GetEntry | The number of times a GET was issued for entry. |
+------------------+--------------------------------------------------+
| PutEntry | The number of times a PUT was issued for entry. |
+------------------+--------------------------------------------------+
| DelEntry | The number of times a DELETE was issued for |
| | entry. |
+------------------+--------------------------------------------------+
| Group | The resource source install group |
+------------------+--------------------------------------------------+
| DefDate | The date and time the resource was defined. |
| DefTime | |
+------------------+--------------------------------------------------+
| ChgDate | The date and time the resource was changed. |
| ChgTime | |
+------------------+--------------------------------------------------+
| ChgUser | The userid that changed the resource. |
+------------------+--------------------------------------------------+
| ChgAgent | The agent that was used to change the resource. |
| | Possible values are: |
| | CREATESPI - EXEC CICS CREATE |
| | CSDAPI - The CEDA transaction or the |
| | programmable interface to DFHEDAP |
| | CSDBATCH - The DFHCSDUP job |
| | DREPAPI - CICSPlex SM BAS API command |
+------------------+--------------------------------------------------+
| AgentLvl | The CICS release that was running when the |
| | resource was changed. |
+------------------+--------------------------------------------------+
| InstDate | The date and time the resource was installed. |
| InstTime | |
+------------------+--------------------------------------------------+
| InstUser | The userid that installed the resource |
+------------------+--------------------------------------------------+
| InstAgent | The agent that was used to install the resource. |
| | Possible values are: |
| | CREATESPI - EXEC CICS CREATE |
| | CSDAPI - The CEDA transaction or the |
| | programmable interface to DFHEDAP |
| | GRPLIST - The resource was installed |
| | by GRPLIST install |
+------------------+--------------------------------------------------+
| ConfigFile | The name and file path of the Atom |
| | configuration file |
+------------------+--------------------------------------------------+
| BindFile | The name and file path of the Atom bind file |
+------------------+--------------------------------------------------+
| ATSE | The address of the Atom Service Element (ATSE) |
| | control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CATPERF

CATPERF Command

The CATPERF command displays information on the performance


of specific services in the CATALOG address space. This

The information displayed is extracted from the responses to


the OS command

MODIFY CATALOG,REPORT,PERFORMANCE

Command Syntax

+---------------+------------------------------------------------------------+
| CATPERF | |
+---------------+------------------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+--------------------+-------------------------------------------------------+
| Field | Description |
+--------------------+-------------------------------------------------------+
| Elapsed | The performance statistics elapsed time. |
+--------------------+-------------------------------------------------------+
| Started | The performance statistics start time and date. |
+--------------------+-------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Event | The name of the CATALOG address space event. If the event |
| | name in the responses to the "MODIFY CATALOG,REPORT |
| | PERFORMANCE" command is blank then the last non-blank |
| | event name is used and repetition count number is |
| | displayed at the end of the event name. |
+---------------+------------------------------------------------------------+
| Count | The number of times the event occurred. |
+---------------+------------------------------------------------------------+
| AvgTime | The average time the event took to complete. |
+---------------+------------------------------------------------------------+

Notes

o The catalog performance statistics can be reset to zero by issuing


the following MVS command:

F CATALOG,REPORT,PERFORMANCE(RESET)

Line Commands
No line commands are defined by the &HelpMember command, however
other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. |
+---------------+------------------------------------------------------------+
CAVARS

CAVARS Command

The CAVARS command displays variables that have been defined


using the CCS common variable service managed by CAMASTER.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| CAVARS | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYSTEM | This forces cross system data collection to be |
| XSDATA | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYSTEM | This forces cross system data collection to be |
| NOXSDATA | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Product,A,Instance,A,Scope,A,Variable,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Product | The product identifier |
+------------------+--------------------------------------------------+
| Instance | The product instance. |
+------------------+--------------------------------------------------+
| Scope | The variable scope. |
| | |
| | Possible values are: |
| | SYSPLEX - Sysplex level scope |
| | SYSTEM - System level scope |
| | |
+------------------+--------------------------------------------------+
| Variable | The defined variable name. |
+------------------+--------------------------------------------------+
| DataType | The data type of the data. |
| | |
| | Possible values are: |
| | UNDEFINE |
| | FLOAT32H |
| | FLOAT64H |
| | FLOAT32B |
| | FLOAT64B |
| | FLOAT32D |
| | FLOAT64D |
| | SIGNED32 |
| | SIGNED64 |
| | STRING |
| | UNSIGN32 |
| | UNSIGN64 |
| | XML |
| | |
+------------------+--------------------------------------------------+
| Length | The length of the data maintained by the |
| | variable. |
+------------------+--------------------------------------------------+
| DataValue | The data contents of the variable. |
+------------------+--------------------------------------------------+
| Persist | The variable is to be persistent. |
+------------------+--------------------------------------------------+
| Notify | Notify via dynamic exit routine when changed. |
+------------------+--------------------------------------------------+
| Ref | Record last reference time. |
+------------------+--------------------------------------------------+
| Force | Permit DELLIKE with PRODUCT mask. |
+------------------+--------------------------------------------------+
| Group | Variable grouping. |
+------------------+--------------------------------------------------+
| System | System name that created item. |
+------------------+--------------------------------------------------+
| User | User / Job name that created item. |
+------------------+--------------------------------------------------+
| Program | Creating program name or PSW. |
+------------------+--------------------------------------------------+
| SysUpdate | System name that last updated item. |
+------------------+--------------------------------------------------+
| UserUpdate | User / Job name that last updated item. |
+------------------+--------------------------------------------------+
| PgmUpdate | Updating program name or PSW. |
+------------------+--------------------------------------------------+
| CreDate | The date and time the variable was created. |
| CreTime | |
+------------------+--------------------------------------------------+
| UpdDate | The date and time the variable was updated. |
| UpdTime | |
+------------------+--------------------------------------------------+
| RefDate | The date and time the variable was last |
| RefTime | referenced. |
+------------------+--------------------------------------------------+
| Token | The variable token. |
+------------------+--------------------------------------------------+
| VDR_NAM | The address of the name segment. |
+------------------+--------------------------------------------------+
| VDR_MET | The address of the meta data segment. |
+------------------+--------------------------------------------------+
| VDR_DAT | The address of the data segment. |
+------------------+--------------------------------------------------+
XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
CBUNDLES

CBUNDLES Command

The CBUNDLES command displays information about an installed


BUNDLE resource.

The contents of a BUNDLE resource are defined in a manifest


that can contain imports, exports, modifiers, and definitions.
The manifest describes the resources that CICS will dynamically
create when a BUNDLE is installed.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CBUNDLES | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Bundle,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Bundle | The name of the BUNDLE. |
+------------------+--------------------------------------------------+
| Status | The status of the BUNDLE resource |
| | |
| | Possible values are: |
| | ENABLED - The bundle is ready for use. |
| | ENABLING - The bundle is being initialized. |
| | DISABLED - The bundle is not available. |
| | DISABLING - The bundle is quiescing before |
| | entering the DISABLED state. |
| | DISCARDING - A DISCARD command was issued |
| | for the bundle. |
| | |
+------------------+--------------------------------------------------+
| AvailStatus | The status of the BUNDLE resource that |
| | represents the CICS bundle. |
| | |
| | Possible values are: |
| | AVAILABLE - Callers can access all the |
| | resources identified in the |
| | bundle as application entry |
| | points. |
| | UNAVAILABLE - Callers cannot access any of |
| | the resources identified in |
| | the bundle as application |
| | entry points. |
| | SOMEAVAIL - Some application entry points |
| | are available and some are |
| | unavailable. |
| | NONE - The bundle does not contain |
| | any statements of application |
| | entry points. |
| | blank - Not supported. |
| | |
+------------------+--------------------------------------------------+
| Parts | The total number of imports, exports, modifiers, |
| | and definition statements that are defined |
| | in the bundle manifest. |
+------------------+--------------------------------------------------+
| Target | The total number of dynamically created |
| | resources, entry points, and policy scopes in |
| | the bundle. |
+------------------+--------------------------------------------------+
| Enabled | The current number of resources and entry |
| | points that were dynamically created by the |
| | bundle and are enabled in the CICS region. |
+------------------+--------------------------------------------------+
| BundleID | The bundle ID. |
+------------------+--------------------------------------------------+
| Major | The major version number of the bundle. |
+------------------+--------------------------------------------------+
| Minor | The minor version number of the bundle. |
+------------------+--------------------------------------------------+
| Micro | The micro version number of the bundle. |
+------------------+--------------------------------------------------+
| MgmtPart | The management part ID of the application or |
| | platform for which the bundle was installed. |
| | If the bundle was not installed for an |
| | application or platform, the value will be blank.|
+------------------+--------------------------------------------------+
| BundleDir | The bundle directory. |
| | A fully qualified name of the root directory |
| | for the bundle on z/OS UNIX. |
+------------------+--------------------------------------------------+
| DefGroup | The source of the resource definition. |
+------------------+--------------------------------------------------+
| InstAgent | The agent that installed the definition. |
+------------------+--------------------------------------------------+
| InstDate | The date and time when the definition was |
| InstTime | installed. |
+------------------+--------------------------------------------------+
| InstUser | The userid that installed the definition. |
+------------------+--------------------------------------------------+
| ChgAgent | The agent that changed the definition. |
+------------------+--------------------------------------------------+
| ChgDate | The date and time when the definition was last |
| ChgTime | changed. |
+------------------+--------------------------------------------------+
| ChgUser | The userid that changed the definition. |
+------------------+--------------------------------------------------+
| ChgLvl | The CICS release of the agent that changed the |
| | definition. |
+------------------+--------------------------------------------------+
| DefDate | The date and time when the definition was |
| DefTime | created. |
+------------------+--------------------------------------------------+
| RLPK | The address of the RLPK control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| CHTAG | Invokes the USSCMD to modify the codeset |
| | associated with the bundle's XML file so that |
| | the file can be read using TSO OEDIT. |
+------------------+--------------------------------------------------+
Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| OEDIT | Invokes the TSO OEDIT command for the bundle's |
| | XML file. |
+------------------+--------------------------------------------------+
| Select | Invokes the CBUNDPAR command to display the |
| | parts for the selected bundle. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.
If the command is executed in SYSTEM mode or XSYSTEM mode, when
supported, no auto switch is performed.
CBUNDPAR

CBUNDPAR Command

The CBUNDPAR command displays information about the resources


contained in an installed BUNDLE resource.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CBUNDPAR | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Bundle,A,BundlePart,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Bundle | The name of the BUNDLE. |
+------------------+--------------------------------------------------+
| BundlePart | The name of a resource contained in the bundle. |
+------------------+--------------------------------------------------+
| Status | The status of the BUNDLE part. |
| | |
| | Possible values are: |
| | ENABLED - The resource is ready for use. |
| | ENABLING - The resource is being created |
| | as part of the BUNDLE resource |
| | installation. |
| | DISABLED - The resource is not available. |
| | DISABLING - The resource is being disabled. |
| | DISCARDING - A DISCARD command has been |
| | issued for the BUNDLE resource. |
| | UNUSABLE - The resource cannot be used. |
| | |
+------------------+--------------------------------------------------+
| AvailStatus | The availability status of the bundle part |
| | resource. |
| | |
| | Possible values are: |
| | AVAILABLE - The bundle part resource is an |
| | application entry point, and it |
| | is available. |
| | UNAVAILABLE - The bundle part resource is an |
| | application entry point, and it |
| | is not available. |
| | NONE - The bundle part resource is not |
| | an application entry point. |
| | blank - Not supported. |
| | |
+------------------+--------------------------------------------------+
| PartClass | The class of the resource defined in the |
| | manifest. |
| | |
| | Possible values are: |
| | DEFINITION - The resource is defined as a |
| | definition in the manifest. |
| | EXPORT - The resource is defined as an |
| | export in the manifest. |
| | ENTRYPOINT - The resource is an entry point |
| | to an application. |
| | IMPORT - The resource is defined as an |
| | import in the manifest. |
| | POLICYSCOPE - The resource is a policy scope |
| | for a policy. |
| | |
+------------------+--------------------------------------------------+
| MetaDataFile | The name of the file on z/OS UNIX that |
| | describes the resource, as defined in the |
| | manifest. |
+------------------+--------------------------------------------------+
| PartType | The resource type as a URL. |
+------------------+--------------------------------------------------+
| Operation | The name of the application operation for which |
| | the resource is declared as an application entry |
| | point. |
+------------------+--------------------------------------------------+
| RLPK | The address of the RLPK control block. |
+------------------+--------------------------------------------------+
| RLRS | The address of the RLRS control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CCEDA

CCEDA Command

The CCEDA command provides easy method of executing CICS CEDA


requests. The resulting response data is displayed.
The CEDA request can be sent to multiple CICS regions.

The interface used to extract CEDA information has a limited


buffer size. Expected data may be truncated. If truncation occurs,
reenter the command requesting more selective or specific data.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Suggested Screen Size

This command is best viewed on a display with a screen size that is


greater than 80 columns.
Follow this link for more information: Dynamic screen sizes

The data contained in the display fields can be large.


The provided field formats have been ordered and sized to display the
information based on typical data. You are encouraged to create new
formats or alter the supplied field formats to meet your needs.

Command Syntax

+------------------+--------------------------------------------------+
| CCEDA | [target_parms] ceda_request |
+------------------+--------------------------------------------------+

Parameters

Target Parms

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

CEDA Request

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| ceda_request | The request string to be processed by CEDA. |
| | |
| | Examples: E L(DFHLIST) |
| | E G(SYSVIEW) |
| | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| ResponseData | The response data generated from the CEDA |
| | request. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Related Information

The CEDA command issues function requests that do not return


a response for display. The responses are logged to the ddname
GSVCLOG file for the corresponding CICS address space.

Security Requirements

CEDA requests execute under the user context assigned to the


GSVI transaction executing in the CICS address space.

Assign a userid to the GSVI CICS transaction


CCEMT

CCEMT Command

The CCEMT command provides easy method of executing CICS CEMT


requests. The resulting response data is displayed.
The CEMT request can be sent to multiple CICS regions.

The interface used to extract CEMT information has a limited


buffer size. Expected data may be truncated. If truncation occurs,
reenter the command requesting more selective or specific data.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Suggested Screen Size

This command is best viewed on a display with a screen size that is


greater than 80 columns.
Follow this link for more information: Dynamic screen sizes

The data contained in the display fields can be large.


The provided field formats have been ordered and sized to display the
information based on typical data. You are encouraged to create new
formats or alter the supplied field formats to meet your needs.

Command Syntax

+------------------+--------------------------------------------------+
| CCEMT | [target_parms] cemt_request |
+------------------+--------------------------------------------------+

Parameters

Target Parms

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

CEMT Request

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| cemt_request | The request string to be processed by CEMT. |
| | |
| | Examples: I TASK |
| | I SYSTEM |
| | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| ResponseData | The response data generated from the CEMT |
| | request. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Related Information

The CEMT command issues function requests that do not return


a response for display. The responses are logged to the ddname
GSVCLOG file for the corresponding CICS address space.

Security Requirements

CEMT requests execute under the user context assigned to the


GSVI transaction executing in the CICS address space.

Assign a userid to the GSVI CICS transaction


CCHANNEL

CCHANNEL Command

The CCHANNEL command displays channels container summary


information.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CCHANNEL | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,


Tran,A,Task#,A,Program,A,Channel,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Tran | The CICS transaction ID |
+------------------+--------------------------------------------------+
| Task# | The CICS transaction or task number |
+------------------+--------------------------------------------------+
| Program | The program name at the current program level |
+------------------+--------------------------------------------------+
| Channel | The channel name |
+------------------+--------------------------------------------------+
| ChanType | The channel type. |
| | Possible values are: |
| | TRAN - Owned by the transaction |
| | PROGRAM - Owned by the program |
+------------------+--------------------------------------------------+
| Container | The number of containers |
+------------------+--------------------------------------------------+
| Size | The total size of all containers in the channel |
| | pool. |
+------------------+--------------------------------------------------+
| GCDSA | The amount of above the bar storage used to hold |
| | all of the container data for the channel pool. |
+------------------+--------------------------------------------------+
| Write | The number of writes to this channel pool. |
+------------------+--------------------------------------------------+
| CodeP | The default code page. |
+------------------+--------------------------------------------------+
| TXN | Specifies the address of the TXn control block |
| | in CICS. |
+------------------+--------------------------------------------------+
| PLCB | The address of the Program Level Control Block. |
+------------------+--------------------------------------------------+
| CHCB | The address of the CHCB control block. |
+------------------+--------------------------------------------------+
| CPCB | The address of the CPCB control bloc. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| SELECT | Invokes the CCONTAIN command for the selected |
| | channel. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CCONFIG

CCONFIG Command

The CCONFIG command displays the current CICS configuration monitoring


options. The values can also be modified.

Command Syntax

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CCONFIG | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
| | [ MEMBER member ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
| Member | The source parmlib member name for the |
| | configuration options. |
| | |
| | Valid values are: |
| | SVWCOPTS |
| | SVWCTSD |
| | * - display all members (default) |
| | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+
| Member | The source parmlib member name for the |
| | configuration options. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname that owns the entry. |
+------------------+--------------------------------------------------+
| Option | The name of the configuration option. |
+------------------+--------------------------------------------------+
| Value | The current value of the configuration option. |
+------------------+--------------------------------------------------+
| Data-Type | The input parameter type. |
| | |
| | Possible values are: |
| | |
| | Character Alphanumeric |
| | Char/Num Either alphanumeric or numeric |
| | Hex Hexadecimal |
| | HH:MM:SS Hours, minutes, and seconds |
| | Keyword Keywords |
| | MicroSec Micro Seconds |
| | Numeric Numeric |
| | Yes/No Either Yes or No |
+------------------+--------------------------------------------------+
| Mod | Indicates that the option value has been |
| | modified from its default value. |
| | |
| | The modified indicator does not necessarily |
| | suggest that the current value is different |
| | from the default value. |
| | The option could have been changed and then set |
| | back to the default value. In this case, the |
| | "Mod" field will display "MOD". |
+------------------+--------------------------------------------------+
| Set | Indicates that the option has been set. |
+------------------+--------------------------------------------------+
| Member | The parmlib member where the configuration |
| | option is specified. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes help positioning to the selected |
| Help | configuration option. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.
If the command is executed in SYSTEM mode or XSYSTEM mode, when
supported, no auto switch is performed.

Related Information

CICS Data Collection Configuration Options

-----------------------------------------------------------------------

Option : ABEND-DUMP-DFHABND
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

If a CICS transaction abends, the contents of the CICS DFHABND


control block can be dumped to the ddname GSVCLOG.
This option can be used to assist in debugging.

Valid values:

No - Do not dump DFHABND contents

Yes - Dump DFHABND contents

-----------------------------------------------------------------------

Option : ABEND-NOTIFICATION
Default : None

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specifies if a message is to be written to the joblog whenever a


CICS transaction abends.

If an abend occurs, an attempt will be made to match the abending


transaction to a definition found in parmlib member CICSDMPM or the
online command CDUMPMGT. If a match is found, the "Abend Notify"
method will be used to determine if and how messages are to be
written. If a match is not found, the default configuration
option specified by the "ABEND-NOTIFICATION" parameter is used.

Valid values:

None - No messages are written.


No

Short - A single GSVC201E message is written.


Yes
Information includes:

Transaction ID
Task number
Abend code
Program
Request ID
Resource

Long - A set of messages are written.


Information includes:

Transaction ID
Task number
Abend code
Program
Request ID
Resource
PSW
Access registers
General registers

-----------------------------------------------------------------------

Option : ALERT-CENTRAL-NOTIFICATION
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

When an exception alert is triggered based on a defined


threshold or state rule, multiple actions can be taken.
One action is to send an event notification to Alert Central.

The action to generate an event notification is specified


on each threshold or state rule definition. This can be
coded as a default for all rules or specifically on each
definition in the respective threshold and state definition
parmlib members or online display commands.

Valid values:

No - Event notifications will not be sent to


Alert Central even if specific threshold
or state definition rules are set
requesting the notification to be sent.
This can be viewed as a global override
setting.

Yes - Event notifications will be sent to


Alert Central if specific threshold
or state definition rules are set
requesting the notification to be sent.

-----------------------------------------------------------------------

Option : APPLICATION-DEBUGGER-IBM-DEBUG
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specifies if active transactions are to be monitored for the


existence of the product IBM Debug for z/OS.

Valid values:

No - Do not detect and determine if the


application debugger is active.
Yes - Detect and determine if the
application debugger is active.

Related options:

APPLICATION-DEBUGGER-XPEDITER
THRESHOLD-TASK-DYNAMIC-APP-DEBUG
THRESHOLD-TASK-DYNAMIC-APP-DEBUG-CANCEL

-----------------------------------------------------------------------

Option : APPLICATION-DEBUGGER-XPEDITER
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specifies if active transactions are to be monitored for the


existence of the product Compuware Xpediter.

Valid values:

No - Do not detect and determine if the


application debugger is active.

Yes - Detect and determine if the


application debugger is active.

Related options:

APPLICATION-DEBUGGER-IBM-DEBUG
THRESHOLD-TASK-DYNAMIC-APP-DEBUG
THRESHOLD-TASK-DYNAMIC-APP-DEBUG-CANCEL

-----------------------------------------------------------------------

Option : ARTM-ACTIVE
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specifies if the Automated Response Time Management function


is to be activated at initialization.

Valid values:

No - Do not activate ARTM

Yes - Activate ARTM

Related options:

ARTM-DEFAULT-TARGET
ARTM-DYNAMIC-ADD
ARTM-MAXIMUM-PRIORITY
ARTM-MEMBER
ARTM-STARTTYPE
ARTM-TRIGGER-COUNT
ARTM-WTRTIME
-----------------------------------------------------------------------

Option : ARTM-DEFAULT-TARGET
Default : 1.000

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify the target response time value to be assigned to a


transaction that is dynamically added to the list of currently
monitored transactions. Transactions are dynamically
added to the list when they execute if the ARTM-DYNAMIC-ADD
option is set to YES.

Related options:

ARTM-ACTIVE
ARTM-DYNAMIC-ADD
ARTM-MAXIMUM-PRIORITY
ARTM-MEMBER
ARTM-STARTTYPE
ARTM-TRIGGER-COUNT
ARTM-WTRTIME

-----------------------------------------------------------------------

Option : ARTM-DYNAMIC-ADD
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify if the ARTM transaction table is to be built dynamically


as new transactions are executed.

Valid values:

No - Transaction is not dynamically added.

Yes - Transaction is dynamically added.

Related options:

ARTM-ACTIVE
ARTM-DEFAULT-TARGET
ARTM-MAXIMUM-PRIORITY
ARTM-MEMBER
ARTM-STARTTYPE
ARTM-TRIGGER-COUNT
ARTM-WTRTIME

-----------------------------------------------------------------------

Option : ARTM-MAXIMUM-PRIORITY
Default : 250

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify the maximum priority the ARTM facility can assign to any
transaction to meet the target response time of the transaction.
Valid values:

Minimum - 1

Maximum - 254

Related options:

ARTM-ACTIVE
ARTM-DEFAULT-TARGET
ARTM-DYNAMIC-ADD
ARTM-MEMBER
ARTM-STARTTYPE
ARTM-TRIGGER-COUNT
ARTM-WTRTIME

-----------------------------------------------------------------------

Option : ARTM-MEMBER
Default : CICSARTM

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

Specify the default member name of the table used to build the
initial list of transactions to be monitored.

Persistent Data Store Information:

If ARTM is active, the ARTM definitions will be maintained


and saved as a member in the persistent data store PDSE
data set.

DataId : CICSARTM_jobname
Size : 480 + ( 80 * definitions )

ReUse : Data is loaded and reused from matching


builds. Data from previous builds is
converted and reused automatically.

The data from the persistent data store


is used only if all of the following are
true. Otherwise, data definitions are
read from the parmlib member specified by
the option: ARTM-MEMBER

* The CICS data collector start mode was WARM

CICS SIT parameter:

INITPARM=(GSVCGSVS='START=WARM')

GSVS initialization transaction:

GSVS START=WARM

* Configuration option:
ARTM-STARTTYPE WARM

Migration : Data members from previous builds can be


deleted if that product build is no longer
being used.

Related options:

ARTM-ACTIVE
ARTM-DEFAULT-TARGET
ARTM-DYNAMIC-ADD
ARTM-MAXIMUM-PRIORITY
ARTM-STARTTYPE
ARTM-TRIGGER-COUNT
ARTM-WTRTIME
DATALIB-AUTO-SAVE

-----------------------------------------------------------------------

Option : ARTM-STARTTYPE
Default : Warm

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

Specifies the start mode of the ARTM component.

Valid values:

Warm - Warm start


Definitions are retrieved from the
persistent data store.

Cold - Cold start


Definitions are read from the parmlib
member defined by the option: ARTM-MEMBER

This value can be overridden during SYSVIEW startup in CICS.


For more information on StartMode see:

CICS data collection start mode

Related options:

ARTM-ACTIVE
ARTM-DEFAULT-TARGET
ARTM-DYNAMIC-ADD
ARTM-MAXIMUM-PRIORITY
ARTM-MEMBER
ARTM-TRIGGER-COUNT
ARTM-WTRTIME

-----------------------------------------------------------------------

Option : ARTM-TRIGGER-COUNT
Default : 25

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify the number of executions of a transaction that must


exceed the target response of the transaction before the
priority of the transaction can be increased by one. All of the
transactions must occur during an interval (called an
above-average interval) in which the average response time of
the transaction was always above the targeted response time.
Although all transactions during an interval are used to
calculate the average response time, only transactions exceeding
the target response time are included in the number required
to increase the priority level of the transaction. If the
average response time for the transaction falls below the
target response time, a new interval (called a below average
interval) begins and the number of transactions required
to increment the priority level of the transaction is reset
to zero. If the number of transactions below the target
response time during a below average interval reaches the
number defined for this option, then the priority of the
transaction is reduced by one.

Valid values:

Minimum - 5

Maximum - 10000

Related options:

ARTM-ACTIVE
ARTM-DEFAULT-TARGET
ARTM-DYNAMIC-ADD
ARTM-MAXIMUM-PRIORITY
ARTM-MEMBER
ARTM-STARTTYPE
ARTM-WTRTIME

-----------------------------------------------------------------------

Option : ARTM-WTRTIME
Default : 0.001

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify the minimum amount of waiting-to-run time that a


transaction must have to increment the trigger counter for
dynamic priority assignment.

Valid values:

Minimum - 0.000001

Maximum - 60

Related options:

ARTM-ACTIVE
ARTM-DEFAULT-TARGET
ARTM-DYNAMIC-ADD
ARTM-MAXIMUM-PRIORITY
ARTM-MEMBER
ARTM-STARTTYPE
ARTM-TRIGGER-COUNT

-----------------------------------------------------------------------
Option : CEAPM-ENABLE
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Cross-Enterprise APM - CICS Transaction Trace integration


provides performance information about CICS transactions.
SYSVIEW provides the performance details for those transactions
that execute in CICS regions.

Specify if CE APM CICS Trace integration is to be enabled.

This option is enabled or disabled automatically based


on the "Option-APM" system configuration option.

It sets automatically when tracing is requested.

If you want to override the automatic setting, specify NO.

Valid values:

Yes - Integration is enabled.

No - Integration is disabled.

-----------------------------------------------------------------------

Option : CEAPM-MRO
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Cross-Enterprise APM - CICS Transaction Trace integration


provides performance information about CICS transactions.
SYSVIEW provides the performance details for those transactions
that execute in CICS regions.

The CICS transactions can run as a transaction within a


single CICS region or as a more complex transaction
running in several CICS MRO regions. This environment is
sometimes referred to as a TOR to AOR environment.

Specify whether transaction correlation is to be performed


in an MRO environment.

The MRO environment will include:

* LINK requests to programs running in a different CICS


region on the same or different z/OS system

* Transaction START requests to initiate a transaction


in the same CICS region

* Transaction START requests to initiate a transaction


in a different CICS region within the same z/OS system

Required options:

CEAPM-ENABLE Yes
Valid values:

No - Do not perform transaction correlation


for MRO transactions.

Yes - Perform transaction correlation for MRO


transactions.

Related options:

CEAPM-MRO-LINK
CEAPM-MRO-SCOPE-SYSPLEX
CEAPM-MRO-START

-----------------------------------------------------------------------

Option : CEAPM-MRO-LINK
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Cross-Enterprise APM - CICS Transaction Trace integration


provides performance information about CICS transactions.
SYSVIEW provides the performance details for those transactions
that execute in CICS regions.

The CICS transactions can run as a transaction within a


single CICS region or as a more complex transaction
running in several CICS MRO regions. This environment is
sometimes referred to as a TOR to AOR environment.

Specify whether transaction correlation is to be performed


for distributed program LINK (DPL) requests.

The option CEAPM-MRO-SCOPE-SYSPLEX is required if a LINK


request is sent to a CICS region on a different sysplex.

Required options:

CEAPM-ENABLE Yes
CEAPM-MRO Yes

Valid values:

No - Do not perform transaction correlation


for distributed program LINKs.

Yes - Perform transaction correlation for


distributed program LINKs.

Related options:

CEAPM-MRO
CEAPM-MRO-SCOPE-SYSPLEX
CEAPM-MRO-START

-----------------------------------------------------------------------

Option : CEAPM-MRO-SCOPE-SYSPLEX
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Cross-Enterprise APM - CICS Transaction Trace integration


provides performance information about CICS transactions.
SYSVIEW provides the performance details for those transactions
that execute in CICS regions.

The CICS transactions can run as a transaction within a


single CICS region or as a more complex transaction
running in several CICS MRO regions. This environment is
sometimes referred to as a TOR to AOR environment.

Specify whether transaction correlation is to be performed


for distributed program LINK (DPL) requests that are sent
to a CICS region on a different system or sysplex.

The CICS channel DFHTRANSACTION will be used to transport


a small amount of correlation data.

If an EXEC CICS LINK PROGRAM request is made using a


COMMAREA, the length of the COMMAREA must not exceed
24 KB if the COMMAREA is passed between two CICS regions.

Required options:

CEAPM-ENABLE Yes
CEAPM-MRO Yes
CEAPM-MRO-LINK Yes

Valid values:

No - Do not perform transaction correlation


for distributed program LINKs.

Yes - Perform transaction correlation for


distributed program LINKs.

Related options:

CEAPM-MRO
CEAPM-MRO-LINK
CEAPM-MRO-START

-----------------------------------------------------------------------

Option : CEAPM-MRO-START
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Cross-Enterprise APM - CICS Transaction Trace integration


provides performance information about CICS transactions.
SYSVIEW provides the performance details for those transactions
that execute in CICS regions.

The CICS transactions can run as a transaction within a


single CICS region or as a more complex transaction
running in several CICS MRO regions. This environment is
sometimes referred to as a TOR to AOR environment.

Specify whether transaction correlation is to be performed


for transaction START requests.

Required options:

CEAPM-ENABLE Yes

Valid values:

No - Do not perform transaction correlation


for transaction START requests.

Yes - Perform transaction correlation for


transaction START requests.

Related options:

CEAPM-MRO
CEAPM-MRO-LINK

-----------------------------------------------------------------------

Option : DATALIB-AUTO-SAVE
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify whether configuration definitions are to be


automatically saved to the persistent data store (DATALIB)
during initialization and termination.

At the end of initialization, configuration information that


was obtained by reading the definitions from a PARMLIB
member (COLD start) will automatically be saved to the
persistent data store so that a WARM start is possible.

During termination, configuration information that has been


altered or updated since initialization will automatically
be saved to the persistent data store so that the
configuration can be reused upon the next WARM start.

If the definitions have not been modified, the checkpoint


of the data will be bypassed (message GSVC176I).

Valid values:

No - Do not store configuration information


in the persistent data store.
Configuration data can be saved manually.

Yes - Store configuration information in the


persistent data store for the following
PARMLIB members:

CICSARTM
CICSDMPM
CICSSCHD
CICSSTAT

-----------------------------------------------------------------------

Option : DUMP-MANAGEMENT
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify if the Dump Management feature is to be enabled.

The CICS Dump Management function can be used to enhance


the CICS-provided function to suppress unwanted dumps.
The built-in function provided by CICS only allows dumps
to be suppressed based on the dump code. The Dump
Management feature extends the suppression criteria to
include the following information:

* Transaction ID
* Program name
* Dump code

Valid values:

No - Do not enable the Dump Management


feature.

Yes - Enable the Dump Management


feature.

Related options:

DUMP-MANAGEMENT-MEMBER
DUMP-MANAGEMENT-STARTTYPE

-----------------------------------------------------------------------

Option : DUMP-MANAGEMENT-MEMBER
Default : CICSDMPM

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

Specify the default member name of the table used to build the
initial list for dump management.

Persistent Data Store Information:

If Dump Management is active, the definitions will be


maintained and saved as a member in the persistent data
store PDSE data set.

DataId : CICSDMPM_jobname
Size : 480 + ( 80 * definitions )

ReUse : Data will be loaded and reused from matching


builds. Data from previous builds will be
converted and reused automatically.

The data from the persistent data store will


only be used if all of the following are
true. Otherwise, data definitions will be
read from the parmlib member specified by
the option: DUMP-MANAGEMENT-MEMBER

* The CICS data collector start mode was WARM

CICS SIT parameter:

INITPARM=(GSVCGSVS='START=WARM')

GSVS initialization transaction:

GSVS START=WARM

* Configuration option:
DUMP-MANAGEMENT-STARTTYPE WARM

Migration : Data members from previous builds can be


deleted if that product build is no longer
being used.

Related options:

DUMP-MANAGEMENT
DUMP-MANAGEMENT-STARTTYPE

-----------------------------------------------------------------------

Option : DUMP-MANAGEMENT-STARTTYPE
Default : Warm

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

Specifies the start mode of the Dump Management feature.

Valid values:

Warm - Warm start


Definitions will be retrieved from the
persistent data store.

Cold - Cold start


Definitions will be read from the parmlib
defined by the option: DUMP-MANAGEMENT-MEMBER

This value can be overridden during SYSVIEW startup in CICS.


For more information on StartMode see:

CICS data collection start mode

Related options:

DUMP-MANAGEMENT
DUMP-MANAGEMENT-MEMBER

-----------------------------------------------------------------------

Option : DUMP-NOTIFICATION
Default : Yes
Change : This option can be modified after initialization
via the CCONFIG or CICSSET commands.

Specifies if a message is to be written to the joblog whenever


CICS takes a dump.

If a dump occurs, an attempt will be made to match the dumping


transaction to a definition found in parmlib member CICSDMPM or the
online command CDUMPMGT. If a match is found, the "Dump Notify"
method will be used to determine if and how messages are to be
written. If a match is not found, the default configuration
option specified by the "DUMP-NOTIFICATION" parameter is used.

Valid values:

No - No messages are written.

Yes - A GSVC118W message is written.

Information includes:
The dump type
The dump code
The dump ID
The active transaction ID
The active task number
The active program
The terminal ID
The userid
The abend code

-----------------------------------------------------------------------

Option : DynAllocUseMsgLevel0
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Controls whether or not DYNALLOC requests should set the


S99MSGL0 flag in the S99RB.

Valid values:

Yes - The DYNALLOC S99MSGL0 option is set for


all dynamic allocation requests. This
causes the dynamic allocation request
to ignore the JCL MSGLEVEL= operand and
to use MSGLEVEL=(,0) instead.

No - The DYNALLOC S99MSGL0 option is not set


for any dynamic allocation request. This
allows normal JCL MSGLEVEL= operand value
to be used.

-----------------------------------------------------------------------

Option : EXTENDED-PRIVATE-LIMIT
Default : 256

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

This option provides the ability to dynamically adjust the


extended private storage limit within a CICS address space.

During CICS data collection initialization, the current


extended private storage limit value will be compared
against the value set by this option. If the value of
the option is larger than the current limit, the extended
private storage limit will be dynamically adjusted to the
specified value.

The value is specified in megabytes.

Valid values:

Minimum - 32 (megabytes)

Maximum - 2047 (megabytes)

-----------------------------------------------------------------------

Option : GRANDE-STORAGE-AUTOSIZE-MEMLIMIT
Default : Yes

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

This option provides the ability to dynamically adjust the


MEMLIMIT value for the CICS address space as needed.

The majority of storage used for monitoring a CICS region via


the SYSVIEW for CICS Data Collector is located in 64-bit storage.
SYSVIEW allocates blocks of 64-bit storage for use and then
manages those blocks internally.

The amount of storage available to the address space is


controlled by the MEMLIMIT= parameter of the EXEC statement.

SYSVIEW makes the assumption that if the MEMLIMIT= parameter


has been specified and is less than 16X, then that amount
of storage will be used by CICS or existing applications.

For this reason, when SYSVIEW allocates 64-bit storage,


the MEMLIMIT value is dynamically adjusted as to not impact
or steal possible storage from the existing applications.

Valid values:

No - Do not adjust or autosize the MEMLIMIT


value.

If 'No' is specified, it is
recommended that you increase the
currently specified MEMLIMIT value
by 1 gigabyte.

Yes - Adjust the MEMLIMIT size as needed.

Related options:
GRANDE-STORAGE-SIZE-LIMIT

-----------------------------------------------------------------------

Option : GRANDE-STORAGE-SIZE-LIMIT
Default : 1G

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

The majority of storage used for monitoring a CICS region via


the SYSVIEW for CICS Data Collector is located in 64-bit storage.
SYSVIEW allocates blocks of 64-bit storage for use and then
manages those blocks internally.

The amount of 64-bit storage allocated by SYSVIEW within a


CICS address space will typically be 32M or less.

This option controls the maximum amount of 64-bit storage


that SYSVIEW can allocate within a CICS address space.

Valid values:

Minimum - 1G (1 gigabyte)

Related options:

GRANDE-STORAGE-AUTOSIZE-MEMLIMIT

-----------------------------------------------------------------------

Option : LIFETIME-EXCLUDE
Default : 00:00:00

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

Specify the elapsed lifetime value for a transaction to be


considered a long running transaction.

Long running transactions take on the following attributes or


characteristics:

* At transaction termination, degradation analysis statistics


are normally summarized for the following:

* Transaction ID specific
* Transaction groups
* All transactions for the CICS region
Example: The '*' entry on the CTRANDEG command.

* Long running transaction tend to have a transaction life time


that is higher than the average transaction. Therefore,
degradation analysis information is not added to the
"all transactions" summary. Adding information to the
"all transactions" summary will adversely skew the timing
values. Transaction usage counts are maintained.

* The transaction life time or elapsed time since attach will not
be evaluated during threshold processing.
Metric: CICS_TRAN_CICS_LifeTime
Valid values:

00:00:00 - Setting the value to zero will cause the


exclusion process to be bypassed.

-----------------------------------------------------------------------

Option : LOG-EXCEPTIONS
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

CICS has the ability to create exception records for events


such as:

* Wait for coupling facility data tables


* Wait for UDSA storage
* Wait for EUDSA storage
* Wait for CDSA storage
* Wait for ECDSA storage
* Wait for SDSA storage
* Wait for ESDSA storage
* Wait for RDSA storage
* Wait for ERDSA storage
* Wait for GCDSA storage
* Wait for temporary storage
* Wait for string associated with a file
* Wait for string associated with LSRPOOL
* Wait for string associated with DFHTEMP
* Wait for buffer associated with LSRPOOL
* Wait for buffer associated with DFHTEMP

The CICS SIT option MNEXC must be set to YES for exception
processing to be active.

The CICS data collector can capture the CICS exception data
and logged historically as an SMF record. The information
can be logged to a variety of destinations.

If the exception occurs during the execution of a transaction,


the exception can be added to the detailed transaction record.

The SMF record containing exception information is sent


to a CICSLOGR running in the SYSVIEW Main Services
Address Space.

If the records are being logged to a log stream, the data


can be viewed via the command: XLOG CICS

The following options defined in the parmlib member CICSLOGR


control the actions taken:

DynamicExit-CICSXLOG
LOG-EXCEPTIONS-SMF
LOGSTREAM-CICSXLOG-NAME

Valid values:

No - Do not capture and log CICS exception


information.

Yes - Capture and log CICS exception information.

Related options:

LOGGER-NAME
MONITOR-EXCEPTIONS

-----------------------------------------------------------------------

Option : LOG-SYSTEM-DATA
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector collects information about the


CICS address space at the system level. This information
can be logged historically as an SMF record. The information
can be logged to a variety of destinations.

The SMF record containing the system information is sent


to a CICSLOGR running in the SYSVIEW Main Services
Address Space.

If the records are being logged to a log stream, the data


can be viewed via the command: CSYSDATA

The following options defined in the parmlib member CICSLOGR


control the actions taken:

DynamicExit-CICSSYSD
LOG-SYSTEM-DATA-SMF
LOGSTREAM-CICSSYSD-NAME

Valid values:

No - Do not log CICS system data records.

Yes - Log CICS system data records.

Related options:

LOGGER-NAME

Related Scheduler Events:

SYSDATA-RECORD

-----------------------------------------------------------------------

Option : LOG-THRESHOLDS
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector monitors a variety of CICS resources


such as: Transactions, Files, DSA storage, etc.
Exceptions alerts can be generated via the monitoring based on
threshold and state definitions.

If an exception alert is generated, several actions can be


taken based on the individual definition. One of the
actions includes creating an SMF record and logging that
record for historical purposes. The record can be logged to
a variety of destinations.

The SMF record containing exception information is sent


to a CICSLOGR running in the SYSVIEW Main Services
Address Space.

If the records are being logged to a log stream, the data


can be viewed via the command: XLOG CICS

The following options defined in the parmlib member CICSLOGR


control the actions taken:

DynamicExit-CICSXLOG
LOG-EXCEPTIONS-SMF
LOGSTREAM-CICSXLOG-NAME

Valid values:

No - Do not log exception alerts.

Yes - Log exception alerts.

Related options:

LOGGER-NAME
THRESHOLD-SYSTEM
THRESHOLD-TASK-DYNAMIC-SMF
THRESHOLD-TASK-END

Related Scheduler Events:

TRAN-THRESHOLDS

-----------------------------------------------------------------------

Option : LOG-TRANSACTION-SUMMARY
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector monitors transactions as they


execute. When a transaction completes, statistical
information regarding resources used, transaction wait
and delay information is summarized for like transaction
IDs.

On a periodic scheduled basis, the summarized transaction


information can be logged historically as an SMF record.

The SMF record containing the transaction summary information


is sent to a CICSLOGR running in the SYSVIEW Main Services
Address Space.
If the records are being logged to a log stream, the data
can be viewed via the command: CTRANSUM

The following options defined in the parmlib member CICSLOGR


control the actions taken:

DynamicExit-CICSTSUM
LOG-TRANSACTION-SUMMARY-SMF
LOGSTREAM-CICSTSUM-NAME

Valid values:

No - Do not log transaction summary records.

Yes - Log transaction summary records.

Related options:

LOGGER-NAME
TRANSACTION-SUMMARY-STATS

Related Scheduler Events:

TRAN-SUMMARY

-----------------------------------------------------------------------

Option : LOG-TRANSACTIONS
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector monitors transactions as they


execute. When a transaction completes, detailed information
regarding resources used, transaction wait and delay
information is formatted as an SMF record for historical
logging.

The SMF record containing the detailed transaction information


is sent to a CICSLOGR running in the SYSVIEW Main Services
Address Space.

If the records are being logged to a log stream, the data


can be viewed via the command: CTRANLOG

The following options defined in the parmlib member CICSLOGR


control the actions taken:

DynamicExit-CICSTRAN
LOG-TRANSACTIONS-SMF
LOGSTREAM-CICSTRAN-NAME

Valid values:

No - Do not log detailed transaction records.

Yes - Log detailed transaction records.

Related options:
LOGGER-NAME
MONITOR-CONVERSE
MONITOR-PERFORMANCE

TRANSACTION-DATA

TRANSACTION-LOG-IF-ABEND
TRANSACTION-LOG-IF-CICSEXC
TRANSACTION-LOG-IF-THRESHOLD

TRANSACTION-RECORD-CSF
TRANSACTION-RECORD-DB2
TRANSACTION-RECORD-DLI
TRANSACTION-RECORD-EXECCICS
TRANSACTION-RECORD-FILES
TRANSACTION-RECORD-MEI-EVENTS
TRANSACTION-RECORD-PROGRAMS
TRANSACTION-RECORD-RSCEMGR
TRANSACTION-RECORD-TEMPSTG
TRANSACTION-RECORD-THRESHOLDS
TRANSACTION-RECORD-TDATA
TRANSACTION-RECORD-USERDATA
TRANSACTION-RECORD-WEBMQ

-----------------------------------------------------------------------

Option : LOGGER-NAME
Default : CICSLOGR

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

The CICS data collector will create SMF records that can be
logged for historical purposes. The records are created
via scheduled intervals and on specific events.

Since the logging of data typically can include I/O and


potential waits, the data is sent to a CICSLOGR task executing
in the SYSVIEW Main Services Address Space or Auxiliary Address
Space.

Multiple CICSLOGR tasks can be defined and executing to


process data. The "LOGGER-NAME" option specifies the task ID
of the CICSLOGR task to be used.

Multiple CICS address space can use a common CICSLOGR task.

-----------------------------------------------------------------------

Option : MEI-DEBUG
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The SYSVIEW for CICS Monitor Exit Interface (MEI) provides


CICS programs or transactions an API into the SYSVIEW for CICS
data collection process.

Information passed to the MEI will be recorded in the detailed


transaction record of the calling transaction.
The MEI-DEBUG option can be used to format MEI parameter blocks
to assist in the diagnosis of potential problems.

The formatted/dumped storage will be written as messages


to the GSVCLOG ddname.

Example snippet of formatted messages:

GSVC146I (Task) MEI Trace 9 TUMB 652 UserData: dataxyz


GSVC910I (Task) Address 00000000_44180C70 Length 00000160
GSVC911I (Task) Offset-- ------+0 ------+4 ------+8 ------+C
GSVC912I (Task) 00000000 00000009 00000000 00000000 00000000
GSVC912I (Task) 00000010 00000000 00000000 00000000 00000000
GSVC912I (Task) 00000020 8481A381 85938594 8595A395 81948540

Enable SYSVIEW Monitor Exit Interface (MEI) debugging.

Valid values:

No - Do not format debug data

Yes - Format debug diagnostic data

Related options:

MEI-LOGGING

-----------------------------------------------------------------------

Option : MEI-LOGGING
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The SYSVIEW for CICS Monitor Exit Interface (MEI) provides


CICS programs or transactions an API into the SYSVIEW for CICS
data collection process.

Information passed to the MEI will be recorded in the detailed


transaction record of the calling transaction.

The MEI-LOGGING option can be used to log MEI requests


to assist in the diagnosis of potential problems.

The log messages will be written to the GSVCLOG ddname.

Example logging messages:

GSVC146I GSVCMEI Trace 9 TUMB 661 UserData: dataelementname


GSVC146I CICSMEI Trace 9 TUMB 661 UserData: ThisIsMyDataKey
GSVC146I CICSMEI Trace 9 TUMB 661 UserData: ThisIsMyCounter
GSVC146I CICSMEI Trace 9 TUMB 661 UserData: ThisIsMyCounter
GSVC146I CICSMEI Trace 9 TUMB 661 UserData: ThisIsMyDataKey2
GSVC146I CICSMEI Trace 9 TUMB 661 UserData: ThisIsMyDataKey3
GSVC146I CICSMEI Trace 6 TUMB 661 Event: EXECCICS Type: Event001
GSVC146I GSVCMEI Trace 6 TUMB 661 Event: GSVCMEI Type: Event001
GSVC146I CICSMEI Trace 1 TUMB 661 Name: TestMEI Type: SYSVIEW
GSVC146I GSVCMEI Trace 5 TUMB 661 FldCode: 6 Data: GSVCMEI
GSVC146I CICSMEI Trace 2 TUMB 661 Program: PROG0001
GSVC146I CICSMEI Trace 2 TUMB 661 Program: PROG0002
GSVC146I GSVCMEI Trace 2 TUMB 661 Program: PROG0003
GSVC146I GSVCMEI Trace 7 TUMB 661 Event: GSVCMEI Type: Event001
GSVC146I CICSMEI Trace 7 TUMB 661 Event: EXECCICS Type: Event001

Valid values:

No - Do not log MEI requests

Yes - Log MEI requests

Related options:

MEI-DEBUG

-----------------------------------------------------------------------

Option : MESSAGE-MLWTO-ENABLED
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Enable messages written to the console or job log via a WTO


request to be written as a multi-line WTO. A single
line WTO message is limited to 126 characters.

Specific messages can be controlled via message attribute


definitions defined in the parmlib member MESSAGES.

Valid values:

No - Any message longer than 126 characters


will be truncated.

Yes - Multi-line WTO processing will be enabled.

Related options:

MESSAGE-MLWTO-INDENT-CHARACTERS
MESSAGE-UPPERCASE

-----------------------------------------------------------------------

Option : MESSAGE-MLWTO-INDENT-CHARACTERS
Default : 9

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

If mult-line WTO messages are enabled, the 2nd through nth


lines can be indented when written. This can be done for
readability.

Valid values:

Minimum - 0 ( no indentation )

Maximum - 16

Related options:
MESSAGE-MLWTO-ENABLED

Examples:

MESSAGE-MLWTO-INDENT-CHARACTERS = 0

GSVC500W (SDCS) TRANDYN CICS_TRAN_CICS_LifeTime


Scope SYSVC001 Name CEMT Qual E010 Task 286 Userid SYSVIEW
V=22.48861 W=7.500000 P=10.00000 UPPER NORMAL PROBLEM
0.000000
Policy 086B7160

MESSAGE-MLWTO-INDENT-CHARACTERS = 9

GSVC500W (SDCS) TRANDYN CICS_TRAN_CICS_LifeTime


Scope SYSVC001 Name CEMT Qual E010 Task 286 Userid SYSVIEW
V=22.48861 W=7.500000 P=10.00000 UPPER NORMAL PROBLEM
0.000000
Policy 086B7160

MESSAGE-MLWTO-INDENT-CHARACTERS = 16

GSVC500W (SDCS) TRANDYN CICS_TRAN_CICS_LifeTime


Scope SYSVC001 Name CEMT Qual E010 Task 286 Userid SYSVIEW
V=22.48861 W=7.500000 P=10.00000 UPPER NORMAL PROBLEM
0.000000
Policy 086B7160

-----------------------------------------------------------------------

Option : MESSAGE-UPPERCASE
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify if messages that are written to the console are to be


translated to uppercase characters.

Valid values:

Yes - Uppercase message text.

No - Do not uppercase message text.

-----------------------------------------------------------------------

Option : MONITOR-CONVERSE
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

During SYSVIEW for CICS initialization, the CICS monitoring


function for handling conversational transactions can be altered.

The CICS SIT parm MNCONV=YES enables CICS to create additional


records for conversational transactions, creating one record for
each terminal input-output pair.
Valid values:

CICS - The monitoring function for converse


is unchanged.

Yes - The monitoring function for converse


is set to yes. This is the same as
setting MNCONV=YES.

No - The monitoring function for converse


is set to no. This is the same as
setting MNCONV=NO.

For more information see CICS Monitor Activation

Related options:

MONITOR-EXCEPTIONS
MONITOR-PERFORMANCE

-----------------------------------------------------------------------

Option : MONITOR-DISPATCH-PRIORITY
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

During initialization, each CICS connects to a specific CICS


logger task running in a SYSVIEW Main Services address space or
SYSVIEW Auxiliary Services address space.

The CICS logger is responsible for the logging of all


historical data for the CICS region.

The address space that executes the CICS logger must execute
with a dispatching priority that is higher than the CICS that
is connecting to it. Multiple CICS regions can connect to a
single CICS logger.

If the CICS region's dispatching priority is higher than


that of the CICS logger address space, it will be possible
for the CICS regions to overload the CICS logger address space.
If the CICS logger is overloaded, data can be lost or discarded.

The activation of dispatch priority monitor will monitor


or compare the dispatching priorities of the CICS region
and connected SYSVIEW CICS logger address space.

If the dispatching priority of the CICS region is greater than


or equal to the SYSVIEW CICS logger address space, an error
message "GSVC065" will be issued.

Valid values:

Yes - Monitor dispatching priorities.

No - Do not monitor dispatching priorities.


A message will be issued at initialization
to document the priorities. Monitoring
will not continue.
-----------------------------------------------------------------------

Option : MONITOR-EXCEPTIONS
Default : CICS

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify if CICS 110 exception records are to be logged to SMF


by CICS.

During SYSVIEW for CICS initialization, the CICS monitoring


function is activated. This is equivalent to setting the
following CICS SIT parameters:

MN=ON
MNEXC=ON

Valid values:

CICS - The SMF 110 exception records are logged


if CICS SIT parameters MN=ON and MNEXC=ON.

Yes - The SMF 110 exception records are


logged.

No - The SMF 110 exception records are not


logged.

For more information see CICS Monitor Activation

Related options:

MONITOR-CONVERSE
MONITOR-PERFORMANCE

-----------------------------------------------------------------------

Option : MONITOR-PERFORMANCE
Default : CICS

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify if CICS 110 performance records are to be logged to


SMF by CICS.

During SYSVIEW for CICS initialization, the CICS monitoring


function is activated. This is equivalent to setting the
following CICS SIT parameters:

MN=ON
MNPER=ON

Valid values:

CICS - The SMF 110 performance records are logged


if CICS SIT parameters MN=ON and MNPER=ON.

Yes - The SMF 110 performance records will be


logged.

No - The SMF 110 performance records will not


be logged.

For more information see CICS Monitor Activation

Related options:

MONITOR-CONVERSE
MONITOR-EXCEPTIONS

-----------------------------------------------------------------------

Option : OPSMVS-EVENT-NOTIFICATION
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

When an exception alert is triggered based on a defined


threshold or state rule, multiple actions can be taken.
One action is to send an event notification to OPS/MVS.

Traditionally, events are triggered by processing console


messages. Console messages are processed by )MSG rules.
Using the event notification action can reduce the number
of console messages and the overhead associated with
processing the messages.

The action to generate an event notification is specified


on each threshold or state rule definition. This can be
coded as a default for all rules or specifically on each
definition in the respective threshold and state definition
parmlib members or online display commands.

The events will be processed by )API type rules.

Event notification rules by component:

MVS - )API CAGSVX0001


IBM MQ - )API CAGSVS0001
IMS - )API CAGSVP0001
TCP/IP - )API CAGSVN0001
CICS - )API CAGSVY0001

Valid values:

No - Event notifications will not be sent to


OPS/MVS even if specific threshold
or state definition rules are set
requesting the notification to be sent.
This can be viewed as a global override
setting.

Yes - Event notifications will be sent to


OPS/MVS if specific threshold
or state definition rules are set
requesting the notification to be sent.

-----------------------------------------------------------------------
Option : SCHEDULER-MEMBER
Default : CICSSCHD

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

The Event Scheduler is a component to schedule time-based


events. The scheduling component is able to perform a
variety of functions at a specified time or a recurring
interval. This option specifies the name of the parmlib member
that contains a list of event definitions to be scheduled.

Persistent Data Store Information:

Event Scheduler definitions will be maintained and saved


as a member in the persistent data store PDSE data set.

DataId : CICSSCHD_jobname
Size : 1680 + ( 800 * definitions )

ReUse : Data will be loaded and reused from matching


builds. Data from previous builds will be
converted and reused automatically.

The data from the persistent data store will


only be used if all of the following are
true. Otherwise, data definitions will be
read from the parmlib member specified by
the option: SCHEDULER-MEMBER

* The CICS data collector start mode was WARM

CICS SIT parameter:

INITPARM=(GSVCGSVS='START=WARM')

GSVS initialization transaction:

GSVS START=WARM

* Configuration option:
SCHEDULER-STARTTYPE WARM

Migration : Data members from previous builds can be


deleted if that product build is no longer
being used.

Related options:

DATALIB-AUTO-SAVE
SCHEDULER-STARTTYPE

-----------------------------------------------------------------------

Option : SCHEDULER-STARTTYPE
Default : Warm

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.
Specifies the start mode of the Event Scheduler component.

Valid values:

Warm - Warm start


Definitions will be retrieved from the
persistent data store.

Cold - Cold start


Definitions will be read from the parmlib
defined by the option: SCHEDULER-MEMBER

This value can be overridden during SYSVIEW startup in CICS.


For more information on StartMode see:

CICS data collection start mode

Related options:

SCHEDULER-MEMBER

-----------------------------------------------------------------------

Option : SOS-NOTIFICATION
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specifies if a message is to be written to the joblog whenever a


CICS short on storage condition occurs.

When a short on storage condition occurs, SYSVIEW will write


the following message:

GSVC144W [dsaname] is short on storage

When a short on storage condition is resolved, SYSVIEW will write


the following message:

GSVC145I [dsaname] is no longer short on storage.


Elapsed time [time]

Valid values:

No - No messages are written.

Yes - Notification messages are written.

-----------------------------------------------------------------------

Option : TERMINAL-STATES-CONSOLE
Default : Yes

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

Specify if the CICS data collector should monitor the states


of CICS terminals that are defined as consoles.

The following terminal attributes can be monitored.


Metric Description
---------------------- ------------------------------------
CICS_TERM_InsStatus Terminal service status
CICS_TERM_TtiStatus Terminal TTI status

Required Scheduler Events:

STATE-TERMINALS

Valid values:

Yes - Monitor console terminals.

No - Do not monitor console terminals.

Related options:

TERMINAL-STATES-MRO
TERMINAL-STATES-VTAM

-----------------------------------------------------------------------

Option : TERMINAL-STATES-MRO
Default : Yes

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

Specify if the CICS data collector should monitor the states


of CICS terminals that are defined as MRO terminals.

The following terminal attributes can be monitored.

Metric Description
---------------------- ------------------------------------
CICS_TERM_AtiStatus Terminal ATI status
CICS_TERM_InsStatus Terminal service status
CICS_TERM_TtiStatus Terminal TTI status

Required Scheduler Events:

STATE-TERMINALS

Valid values:

Yes - Monitor MRO terminals.

No - Do not monitor MRO terminals.

Related options:

TERMINAL-STATES-CONSOLE
TERMINAL-STATES-VTAM

-----------------------------------------------------------------------

Option : TERMINAL-STATES-VTAM
Default : No

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

Specify if the CICS data collector should monitor the states


of CICS terminals that are defined as VTAM terminals.

The following terminal attributes can be monitored.

Metric Description
---------------------- ------------------------------------
CICS_TERM_AcquiredStatus Terminal status
CICS_TERM_AtiStatus Terminal ATI status
CICS_TERM_CreateStatus Terminal create status
CICS_TERM_InsStatus Terminal service status
CICS_TERM_TtiStatus Terminal TTI status

Required Scheduler Events:

STATE-TERMINALS

Valid values:

Yes - Monitor VTAM terminals.

No - Do not monitor VTAM terminals.

Related options:

TERMINAL-STATES-CONSOLE
TERMINAL-STATES-MRO

-----------------------------------------------------------------------

Option : THRESHOLD-SYSTEM
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify if the CICS data collector is to perform exception


processing for system related metrics.

Valid values:

Yes - Perform exception processing

No - Do not perform exception processing

-----------------------------------------------------------------------

Option : THRESHOLD-TASK-DYNAMIC-APP-DEBUG
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify if dynamic thresholding will occur for transactions


with an application debugger active. An application debugger
will elongate or change the normal execution of a transaction.
It is generally assumed that the transaction will not meet
its normal goals and thresholding should be bypassed
while the application debugger is active.
Valid values:

No - Do not process exception definitions


for a transaction while an application
debugger is active.

Yes - Process exception definitions for a


transaction while an application
debugger is active.

Related options:

APPLICATION-DEBUGGER-XPEDITER
THRESHOLD-TASK-DYNAMIC-APP-DEBUG-CANCEL

-----------------------------------------------------------------------

Option : THRESHOLD-TASK-DYNAMIC-APP-DEBUG-CANCEL
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify whether dynamic thresholding can trigger a transaction


to be cancelled while an application debugger is active.

An application debugger will elongate or change the normal


execution of a transaction. It is generally assumed that the
transaction will not meet its normal goals. Any exception
definition requesting the transaction to be cancelled should
by bypassed.

Valid values:

No - Do not cancel a transaction while an


application debugger is active.

Yes - A transaction can be cancelled while


an application debugger is active if an
exception definition requests
cancellation.

Required options:

THRESHOLD-TASK-DYNAMIC-APP-DEBUG

Related options:

APPLICATION-DEBUGGER-XPEDITER

-----------------------------------------------------------------------

Option : THRESHOLD-TASK-DYNAMIC-MXTDELAY
Default : Auto

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify if the CICS data collector is to perform exception


processing on an interval basis for those tasks that have
not been dispatched for the first time due to max task or
transaction class max conditions.

An increase in CPU overhead can occur if processing


is ALWAYS performed and the queue of tasks that have
been delayed for 1st dispatch is long.

Required Scheduler Events:

TRAN-THRESHOLDS

Valid values:

Yes - Perform exception processing

No - Do not perform exception processing

Auto - Perform exception processing only if


at least one of the following metrics
has been defined as a threshold
exception definition:

CICS_TRAN_TASK_MaxtDelay
CICS_TRAN_TASK_TClassDelay

Related options:

THRESHOLD-TASK-DYNAMIC-SMF
THRESHOLD-TASK-END

-----------------------------------------------------------------------

Option : THRESHOLD-TASK-DYNAMIC-SMF
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor active tasks and create
exceptions or alerts when defined exception rules are
exceeded.

Specify if an exception record is to be created and written


to SMF for active tasks.

Required Scheduler Events:

TRAN-THRESHOLDS

Valid values:

Yes - Create and log exception records to SMF

No - Do not create and log exception records


to SMF

-----------------------------------------------------------------------

Option : THRESHOLD-TASK-END
Default : No
Change : This option can be modified after initialization
via the CCONFIG or CICSSET commands.

The CICS data collector monitors transactions as they


execute. When a transaction completes, resources used can be
evaluated against defined exception rules.

Valid values:

Yes - Evaluate and process exceptions for


transactions at task completion.

No - Do not evaluate and process exceptions for


transactions at task completion.

The following related options are required:

TRANSACTION-DATA Yes

-----------------------------------------------------------------------

Option : THRESHOLD-UMBRELLA
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS Monitor Exit Interface (MEI) can be used to assign an


umbrella name to a transaction.

Valid values:

Yes - If an umbrella name exists, threshold checking


is first performed using the umbrella name
rather than the transaction ID. If no matching
threshold definition is found for the umbrella
name, threshold checking is performed using
the transaction ID.

No - Do not use the umbrella name for threshold


checking, always use the transaction ID.

-----------------------------------------------------------------------

Option : TRANSACTION-ACTIVITY-PERSISTENT
Default : No

Transaction summary statistics are collected and summarized on


a 1 minute interval. The interval statistics are maintained
for the last 24 hours. The data is a "rolling" 24 hour period
and not for the current day. The information can be maintained
across restarts of the data collector as well as restarts
of the CICS region.

This information can be displayed using the online command


CREVIEW.

Valid values:

No - Statistics are not to be maintained


across restarts.

Restart - Statistics are to be maintained across


restarts of the data collection within
a single execution of the CICS region.

Yes - Statistics are to be maintained across


restarts of the data collection and
across multiple executions of the
CICS region.

If statistics are being maintained across restarts of any type,


the data is saved as a member in the persistent data store
PDSE data set.

Persistent Data Store Information:

DataId : GSVCACTV_jobname
Size : 518K

ReUse : Data will be loaded and reused from matching


builds only.

Migration : Data members from previous builds can be


deleted if that product build is no longer
being used.

-----------------------------------------------------------------------

Option : TRANSACTION-CANCEL-AT-SHUTDOWN
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

During the shutdown of CICS, it is common for long-running


transactions or conversational transactions waiting for
terminal I/O to delay the shutdown of the CICS region.

The CICS data collector can automatically cancel those


transactions that are delaying the shutdown process.

The following transaction attributes can be specified


to determine which transactions, if any, are to be canceled:

* Transaction ID
* Facility name (terminal, transient data queue)
* Suspend Type
* Suspend value

Valid values:

Yes - Enable transaction cancelation at shutdown

No - Disable transaction cancelation at shutdown

-----------------------------------------------------------------------

Option : TRANSACTION-CANCEL-DYNAMIC
Default : Yes
Change : This option can be modified after initialization
via the CCONFIG or CICSSET commands.

Specifies if transactions can be canceled dynamically based


on threshold exception definitions.

Required Scheduler Events:

TRAN-THRESHOLDS

Valid values:

Yes - The cancellation rule specified within


a threshold definition will be respected.

No - Transactions will not be canceled based on


threshold definitions. This can be used to
temporarily override threshold definitions.

-----------------------------------------------------------------------

Option : TRANSACTION-DATA
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect information


about transactions as they execute.

Valid values:

No - Do not enable collection of transaction


information. Realtime monitoring is
still available. Historical information
will not be available.

Yes - Enable collection of transaction information.

-----------------------------------------------------------------------

Option : TRANSACTION-DATA-DB2
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about requests and resources used by a transaction.

This option controls the collection of data made available via


CICS global user exits related to the following CICS domain:

RM - Resource Manager

DB2 requests are made through the CICS Resource Manager.


This option enables the collection of detailed DB2 request
information.

The following related options are required:


TRANSACTION-DATA Yes

Detailed performance information regarding the overhead


associated with this option can be viewed using the
online command: CGBLEXIT

Valid values:

No - Do not collect data

SUMMARY - Collect DB2 request information by the


Yes specific program and request type.

DETAIL - Collect DB2 request information by the


specific program, request type and
statement number.

Related options:

TRANSACTION-DATA-DB2-SEGMENTS
TRANSACTION-RECORD-DB2

-----------------------------------------------------------------------

Option : TRANSACTION-DATA-DB2-SEGMENTS
Default : 100

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about DB2 requests made by a transaction.

The DB2 requests can be collected by unique combinations


of the following "segment keys":

Program
Type
Statement

A long running transaction making DB2 requests can produce


a very large number of unique segment keys. A very large
number of keys can have a negative impact on performance.
For this reason, the number of unique segment keys can be
controlled.

If the segment limit is reached, no data will be lost.


An additional generic segment will be created.

The following related options are required:

TRANSACTION-DATA Yes
TRANSACTION-DATA-DB2 Yes

Valid values:

Minimum - 1

Maximum - 1000
Related options:

TRANSACTION-DATA-DB2
TRANSACTION-RECORD-DB2

-----------------------------------------------------------------------

Option : TRANSACTION-DATA-DLI
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about requests and resources used by a transaction.

This option controls the enablement of CICS global user exits


related to the following CICS domain. The exits must be enabled
to collect the related data.

DL - DL/I Interface

Global user exits to be enabled:

Exitname Description (when the exit is invoked)


-------- -----------------------------------------------------
XDLIPRE On entry to the DL/I interface program.

XDLIPOST On exit from the DL/I interface program.

Detailed performance information regarding the overhead


associated with this option can be viewed using the
online command: CGBLEXIT

Valid values:

No - Do not collect data

Yes - Collect data

Related options:

TRANSACTION-RECORD-DLI

-----------------------------------------------------------------------

Option : TRANSACTION-DATA-EXECCICS
Default : CEITRACE

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about requests and resources used by a transaction.

If CICS EXEC Interface requests are being monitored or traced,


the EXEC Interface requests will be included in the CICS
transaction record.

This option controls the enablement of CICS global user exits


related to the following CICS domain. The exits must be enabled
to collect the related data.

EI - EXEC Interface

Global user exits to be enabled:

Exitname Description (when the exit is invoked)


-------- -----------------------------------------------------
XEIIN Before any EXEC CICS API or SPI command runs.

XEIOUT After any EXEC CICS API or SPI command runs.

XEISPIN Before any EXEC CICS SPI command except:

EXEC CICS ENABLE


EXEC CICS DISABLE
EXEC CICS EXTRACT EXIT
EXEC CICS PERFORM DUMP
EXEC CICS RESYNC ENTRYNAM

XEISPOUT After any EXEC CICS SPI command except

EXEC CICS ENABLE


EXEC CICS DISABLE
EXEC CICS EXTRACT EXIT
EXEC CICS PERFORM DUMP
EXEC CICS RESYNC ENTRYNAME

Detailed performance information regarding the overhead


associated with this option can be viewed using the
online command: CGBLEXIT

Valid values:

No - Do not collect data.

Yes - Collect data. The collected data


will be summarized by requesting
program name and EXEC CICS
request. EXEC Interface requests
will be collected for all
transactions and the CEITRACE
definitions noted below will not
be used.

If option TRANSACTION-RECORD-EXECCICS
is set to YES, this data will be
included in the transaction record
viewable using the CTRANLOG command.

CEITRACE - Data collection will be enabled.


EXEC Interface trace definitions
will be used to determine if
EXEC Interface requests will be
collected for a specific
transaction.

EXEC Interface trace definitions


are defined in the parmlib member
CEITRACE. The definitions can be
dynamically modified using the
online command: CEITRACE

If option TRANSACTION-RECORD-EXECCICS
is set to YES, any collected EXEC
Interface requests will be included
in the transaction record viewable
using the CTRANLOG and CEITLOG commands.

Related options:

TRANSACTION-RECORD-EXECCICS

-----------------------------------------------------------------------

Option : TRANSACTION-DATA-FILES
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about requests and resources used by a transaction.

This option controls the enablement of CICS global user exits


related to the following CICS domain. The exits must be enabled
to collect the related detail data. The exits are not enabled
in SUMMARY mode.

FC - File Control

Global user exits to be enabled in DETAIL mode:

Exitname Description (when the exit is invoked)


-------- -----------------------------------------------------
XFCFRIN Before a file control request runs.

XFCFROUT After a file control request runs.

Detailed performance information regarding the overhead


associated with this option can be viewed using the
online command: CGBLEXIT

Valid values:

No - Do not collect data

SUMMARY - File request information will be collected


for the files accessed.
The data will include:

* Filename
* Total requests and time
* Requests and total request time
for the following:
o ADD
o BROWSE
o DELETE
o GET
o PUT

Requirement:
CICS resource monitoring for files must be active.

If CICS SIT option MNRES=OFF:

* SYSVIEW will dynamically set MNRES=ON


* A non-zero value must be specified on
the FILE=nn option on the
DFHMCT TYPE=INITIAL macro.
* To avoid unnecessary resource monitoring,
DPL=0 and TSQUEUE=0 can be specified on
the DFHMCT TYPE=INITIAL macro.

If CICS SIT option MNRES=ON:

* A non-zero value must be specified on the


FILE=nn option on the DFHMCT TYPE=INITIAL macro.

DETAIL - File request information will be collected


Yes for the files accessed.
The data will include:

* Filename
* Program
* SysID
* Total requests and time
* Requests, max request time and total
request time for the following:
o ADD
o BROWSE
o DELETE
o END BROWSE
o READ
o READ for UPDATE
o RESET BROWSE
o START BROWSE
o UNLOCK
o UPDATE

Threshold processing considerations:


In SUMMARY mode threshold processing for the FILExxxx data
collection metrics only occurs when the transaction ends.
Dynamic threshold processing of these metrics while the
transaction is executing requires DETAIL mode.

In addition to transaction detail records, summarized request


information is also available using the SYSVIEW command: CFILEREQ

Related options:

TRANSACTION-DATA-FILES-SEGMENTS
TRANSACTION-RECORD-FILES

-----------------------------------------------------------------------

Option : TRANSACTION-DATA-FILES-SEGMENTS
Default : 100

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about file requests made by a transaction.

The file requests can be collected by unique combinations


of the following "segment keys":

Program
File

A long running transaction making file requests can produce


a very large number of unique segment keys. A very large
number of keys can have a negative impact on performance.
For this reason, the number of unique segment keys can be
controlled.

If the segment limit is reached, no data will be lost.


An additional generic segment "(OTHER)" will be created.

The following related options are required:

TRANSACTION-DATA Yes
TRANSACTION-DATA-FILES Yes

Valid values:

0 - All file information will be collected


with a resource name of "(ALL)".

Minimum - 1

Maximum - 100

Related options:

TRANSACTION-DATA-FILES
TRANSACTION-RECORD-FILES

-----------------------------------------------------------------------

Option : TRANSACTION-DATA-PROGRAMS
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about requests and resources used by a transaction.

This option controls the enablement of CICS global user exits


related to the following CICS domain. The exits must be enabled
to collect the related data.

PC - Program Control

Global user exits to be enabled:

Exitname Description (when the exit is invoked)


-------- -----------------------------------------------------
XPCFTCH Before an application program is given control.

XPCTA After an abend occurs and before the environment is


modified.
XPCREQ Before a LINK request is processed.

XPCREQC After a LINK request has been completed.

XPCERES Before processing of a program link or


Link3270 bridge request that has been
dynamically routed

Detailed performance information regarding the overhead


associated with this option can be viewed using the
online command: CGBLEXIT

Valid values:

No - Do not collect data

Yes - Collect data

Related options:

TRANSACTION-RECORD-PROGRAMS

-----------------------------------------------------------------------

Option : TRANSACTION-DATA-PROGRAMS-CALLS
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect the usage of
calls to programs that do not utilize EXEC CICS LINK or XCTL.
These calls are sometimes referred to as COBOL dynamic calls.

The program called by a COBOL dynamic call is loaded by CICS


using an EXEC CICS LOAD.

Elapsed timing of the called programs is not recorded.

This option controls the enablement of CICS global user exits


related to the following CICS domain. The exits must be enabled
to collect the related data.

EI - EXEC Interface

Global user exits to be enabled:

Exitname Description (when the exit is invoked)


-------- -----------------------------------------------------
XEIOUT After any EXEC CICS API or SPI command runs.

Detailed performance information regarding the overhead


associated with this option can be viewed using the
online command: CGBLEXIT

Valid values:

No - Do not collect data

Yes - Collect program usage data.


Required options:

TRANSACTION-DATA-PROGRAMS

Related options:

TRANSACTION-DATA-EXECCICS

* Program calls will also be collected if the option


is active for a transaction.

-----------------------------------------------------------------------

Option : TRANSACTION-DATA-RSCEMGR
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about requests and resources used by a transaction.

This option controls the enablement of CICS global user exits


related to the following CICS domain. The exits must be enabled
to collect the related data.

RM - Resource Manager

Global user exits to be enabled:

Exitname Description (when the exit is invoked)


-------- -----------------------------------------------------
XRMIIN Before an EXEC DLI, EXEC SQL, or RMI command runs.

XRMIOUT After an EXEC DLI, EXEC SQL, or RMI command runs.

Detailed performance information regarding the overhead


associated with this option can be viewed using the
online command: CGBLEXIT

Valid values:

No - Do not collect data

Yes - Collect data

Related options:

TRANSACTION-DATA-DB2
TRANSACTION-DATA-WEBMQ
TRANSACTION-RECORD-RSCEMGR

-----------------------------------------------------------------------

Option : TRANSACTION-DATA-TDATA
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.
The CICS data collector can monitor and collect detailed
information about requests and resources used by a transaction.

This option controls the enablement of CICS global user exits


related to the following CICS domain. The exits must be enabled
to collect the related data.

TD - Transient Data

Global user exits to be enabled:

Exitname Description (when the exit is invoked)


-------- -----------------------------------------------------
XTDREQ Before request analysis.

XTDIN After receiving data from QSAM (extrapartition)


or VSAM (intrapartition).

XTDOUT Before passing data to a QSAM (extrapartition)


or VSAM (intrapartition) user-defined
transient data queue.

Detailed performance information regarding the overhead


associated with this option can be viewed using the
online command: CGBLEXIT

Valid values:

No - Do not collect data

Yes - Collect data

Related options:

TRANSACTION-RECORD-TDATA

-----------------------------------------------------------------------

Option : TRANSACTION-DATA-TEMPSTG
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about requests and resources used by a transaction.

This option controls the enablement of CICS global user exits


related to the following CICS domain. The exits must be enabled
to collect the related data.

TS - Temporary Storage Domain

Global user exits to be enabled:

Exitname Description (when the exit is invoked)


-------- -----------------------------------------------------
XTSQRIN Before invocation of a TSQR function.

XTSQROUT After invocation of a TSQR function.


Detailed performance information regarding the overhead
associated with this option can be viewed using the
online command: CGBLEXIT

This option must be set to YES for the following System


Data Collection metric to be collected:

Metric Description
--------------------- --------------------------------------
CICS_TEMP_TsmainHWM Temp Storage - TSMain in use HWM
CICS_TEMP_TsmainHWM% Temp Storage - TSMain in use pct HWM
CICS_TEMP_QueuesHWM Temp Storage - Queues in use HWM

Valid values:

No - Do not collect data

Yes - Collect data

Related options:

TRANSACTION-DATA-TEMPSTG-SEGMENTS
TRANSACTION-RECORD-TEMPSTG

-----------------------------------------------------------------------

Option : TRANSACTION-DATA-TEMPSTG-SEGMENTS
Default : 10

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about temporary storage requests made by a
transaction.

The requests can be collected by unique queue name.

A long running transaction making requests can use a


a very large number of queues. A very large number
of keys can have a negative impact on performance.
For this reason, the number of unique segment keys can be
controlled.

If the segment limit is reached, no data will be lost.


An additional generic segment "(OTHER)" will be created.

The following related options are required:

TRANSACTION-DATA Yes
TRANSACTION-DATA-TEMPSTG Yes

Valid values:

0 - All file information will be collected


with a resource name of "(ALL)".

Minimum - 1

Maximum - 100
Related options:

TRANSACTION-DATA-TEMPSTG
TRANSACTION-RECORD-TEMPSTG

-----------------------------------------------------------------------

Option : TRANSACTION-DATA-URIMAPS
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect information


about URIMAP requests and resources used by a transaction.

CICS TS 5.5 or higher is required.

Valid values:

No - Do not collect data


Yes - Collect data

Requirement:
CICS resource monitoring for URIMAPs must be active.

If CICS SIT option MNRES=OFF:

* SYSVIEW will dynamically set MNRES=ON


* A non-zero value must be specified on
the URIMAP=nn option on the
DFHMCT TYPE=INITIAL macro.

If CICS SIT option MNRES=ON:

* A non-zero value must be specified on the


URIMAP=nn option on the DFHMCT TYPE=INITIAL macro.

-----------------------------------------------------------------------

Option : TRANSACTION-DATA-WEBMQ
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about requests and resources used by a transaction.

This option controls the collection of data made available via


CICS global user exits related to the following CICS domain:

RM - Resource Manager

IBM MQ requests are made through the CICS Resource Manager.


This option enables the collection of detailed IBM MQ
request information.

The following related options are required:

TRANSACTION-DATA Yes
Detailed performance information regarding the overhead
associated with this option can be viewed using the
online command: CGBLEXIT

Valid values:

No - Do not collect data

Yes - Collect data

Related options:

CEAPM-ENABLE
TRANSACTION-RECORD-WEBMQ

-----------------------------------------------------------------------

Option : TRANSACTION-DATA-WEBSERVICES
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect information


about Web Service requests and resources used by a transaction.

CICS TS 5.5 or higher is required.

Valid values:

No - Do not collect data


Yes - Collect data

Requirement:
CICS resource monitoring for Web Services must
be active.

If CICS SIT option MNRES=OFF:

* SYSVIEW will dynamically set MNRES=ON


* A non-zero value must be specified on
the WEBSERVC=nn on on the
DFHMCT TYPE=INITIAL macro.

If CICS SIT option MNRES=ON:

* A non-zero value must be specified on the


WEBSERVC=nn option on the DFHMCT TYPE=INITIAL
macro.

-----------------------------------------------------------------------

Option : TRANSACTION-LOG-IF-ABEND
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify if a transaction record is to be ALWAYS logged


if an abend or dump occurred while the transaction was executing.
This is only a concern if a NOLOG attribute has been
specified as a transaction option in a CTRANOPT parmlib definition
or the online CTRANOPT command.

The following related options are required:

TRANSACTION-RECORD-THRESHOLDS Yes

Valid values:

Yes - If an abend occurs, a transaction record


will be logged even if the NOLOG attribute
has been specified on a transaction option
definition.

No - Do not force a transaction record to be


logged if the NOLOG attribute has been
specified on a transaction option definition.

Related options:

TRANSACTION-LOG-IF-CICSEXC
TRANSACTION-LOG-IF-THRESHOLD

-----------------------------------------------------------------------

Option : TRANSACTION-LOG-IF-CICSEXC
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify if a transaction record is to be ALWAYS logged


if a CICS exception event occurs while the transaction
was executing. A storage violation is considered an
exception.

This is only a concern if a NOLOG attribute has been


specified as a transaction option in a CTRANOPT parmlib definition
or the online CTRANOPT command.

The following related options are required:

TRANSACTION-RECORD-THRESHOLDS Yes

Valid values:

Yes - If an CICS exception occurs, a transaction


record will be logged even if the NOLOG
attribute has been specified on a transaction
option definition.

No - Do not force a transaction record to be


logged if the NOLOG attribute has been
specified on a transaction option definition.

Related options:

TRANSACTION-LOG-IF-ABEND
TRANSACTION-LOG-IF-THRESHOLD
-----------------------------------------------------------------------

Option : TRANSACTION-LOG-IF-THRESHOLD
Default : No

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify if a transaction record is to be ALWAYS logged


if a SYSVIEW threshold was triggered for the specific
transaction.

This is only a concern if a NOLOG attribute has been


specified as a transaction option in a CTRANOPT parmlib definition
or the online CTRANOPT command.

The following related options are required:

TRANSACTION-RECORD-THRESHOLDS Yes

Valid values:

Yes - If an exception occurs, a transaction record


will be logged even if the NOLOG attribute
has been specified on a transaction option
definition.

No - Do not force a transaction record to be


logged if the NOLOG attribute has been
specified on a transaction option definition.

Related options:

TRANSACTION-LOG-IF-ABEND
TRANSACTION-LOG-IF-CICSEXC

-----------------------------------------------------------------------

Option : TRANSACTION-RECORD-CICSEMP
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about requests and resources used by a transaction.

User data can be defined in the CICS Monitor Control Table (MCT).
The CICS MCT EMP data fields can be included in the detailed
transaction record for a transaction.

Required options:

TRANSACTION-DATA Yes

Valid values:

No - Do not include CICS MCT EMP data fields


in the detailed transaction record.
Yes - Include CICS MCT EMP data fields
in the detailed transaction record.

-----------------------------------------------------------------------

Option : TRANSACTION-RECORD-CSF
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about Datacom CICS Service Facility (CSF)
requests and resources used by transactions.

The data is recorded historically as segment data in the


detailed transaction record.

When the detailed transaction is logged, the CSF data


can optionally be included or excluded from the record.

Valid values:

No - Do not include CSF data

Yes - Include CSF data

-----------------------------------------------------------------------

Option : TRANSACTION-RECORD-DB2
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about DB2 requests and resource used by
transactions.

The data is recorded historically as segment data in the


detailed transaction record.

When the detailed transaction is logged, the DB2 data


can optionally be included or excluded from the record.

The following related options are required:

TRANSACTION-DATA Yes
TRANSACTION-DATA-DB2 Yes

Valid values:

No - Do not include DB2 data

Yes - Include DB2 data

Related options:

TRANSACTION-DATA-DB2
TRANSACTION-DATA-DB2-SEGMENTS
-----------------------------------------------------------------------

Option : TRANSACTION-RECORD-DLI
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about DL/I requests and resource used by
transactions.

The data is recorded historically as segment data in the


detailed transaction record.

When the detailed transaction is logged, the DL/I data


can optionally be included or excluded from the record.

The following related options are required:

TRANSACTION-DATA Yes
TRANSACTION-DATA-DLI Yes

Valid values:

No - Do not include DL/I data

Yes - Include DL/I data

Related options:

TRANSACTION-DATA-DLI

-----------------------------------------------------------------------

Option : TRANSACTION-RECORD-EXECCICS
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about EXEC CICS requests made by transactions.

The data is recorded historically as segment data in the


detailed transaction record.

When the detailed transaction is logged, the EXEC CICS data


can optionally be included or excluded from the record.

The following related options are required:

TRANSACTION-DATA Yes
TRANSACTION-DATA-EXECCICS Yes / CEITRACE

Valid values:

No - Do not include EXEC CICS data.


EXEC CICS requests will not be included in
the detailed transaction record, and the
transaction record will not be eligible for
logging to the EXEC Interface trace log
(CEITLOG).

Yes - Include EXEC CICS data

Related options:

TRANSACTION-DATA-EXECCICS

-----------------------------------------------------------------------

Option : TRANSACTION-RECORD-FILES
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about file requests made by transactions.

The data is recorded historically as segment data in the


detailed transaction record.

When the detailed transaction is logged, the file request


data can optionally be included or excluded from the record.

The following related options are required:

TRANSACTION-DATA Yes
TRANSACTION-DATA-FILES Yes

Valid values:

No - Do not include file request data

Yes - Include file request data

Related options:

TRANSACTION-DATA-FILES
TRANSACTION-DATA-FILES-SEGMENTS

-----------------------------------------------------------------------

Option : TRANSACTION-RECORD-MEI-EVENTS
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect user defined
events. Event monitoring is initiated using the SYSVIEW
Monitor Exit Interface (MEI).

The data is recorded historically as segment data in the


detailed transaction record.

When the detailed transaction is logged, the MEI Event data


can optionally be included or excluded from the record.

The following related options are required:


TRANSACTION-DATA Yes

Valid values:

No - Do not include MEI Event data

Yes - Include MEI Event data

-----------------------------------------------------------------------

Option : TRANSACTION-RECORD-PROGRAMS
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about program usage by transactions.

The data is recorded historically as segment data in the


detailed transaction record.

When the detailed transaction is logged, the program usage


data can optionally be included or excluded from the record.

The following related options are required:

TRANSACTION-DATA Yes
TRANSACTION-DATA-PROGRAMS Yes

Valid values:

No - Do not include program usage data

Yes - Include program usage data

Related options:

TRANSACTION-DATA-PROGRAMS

-----------------------------------------------------------------------

Option : TRANSACTION-RECORD-RSCEMGR
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about resource manager requests made by transactions.

The data is recorded historically as segment data in the


detailed transaction record.

When the detailed transaction is logged, the resource manager


data can optionally be included or excluded from the record.

The following related options are required:

TRANSACTION-DATA Yes
TRANSACTION-DATA-RSCEMGR Yes

Valid values:

No - Do not include resource manager data

Yes - Include resource manager data

Related options:

TRANSACTION-DATA-RSCEMGR

-----------------------------------------------------------------------

Option : TRANSACTION-RECORD-TEMPSTG
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about temporary storage requests by transactions.

The data is recorded historically as segment data in the


detailed transaction record.

When the detailed transaction is logged, the temporary


storage request data can optionally be included or excluded
from the record.

The following related options are required:

TRANSACTION-DATA Yes
TRANSACTION-DATA-TEMPSTG Yes

Valid values:

No - Do not include temporary storage data

Yes - Include temporary storage data

Related options:

TRANSACTION-DATA-TEMPSTG
TRANSACTION-DATA-TEMPSTG-SEGMENTS

-----------------------------------------------------------------------

Option : TRANSACTION-RECORD-THRESHOLDS
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about exceptions generated for transactions.

The data is recorded historically as segment data in the


detailed transaction record. Those segments include ABEND,
CICSEXC, and THRESHOLD.
When the detailed transaction is logged, the exception
data can optionally be included or excluded from the record.

The following related options are required:

TRANSACTION-DATA Yes
THRESHOLD-TASK-END Yes

Valid values:

No - Do not include exception data

Yes - Include exception data

Related options:

TRANSACTION-LOG-IF-ABEND
TRANSACTION-LOG-IF-CICSEXC
TRANSACTION-LOG-IF-THRESHOLD

-----------------------------------------------------------------------

Option : TRANSACTION-RECORD-TDATA
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about transient data requests by transactions.

The data is recorded historically as segment data in the


detailed transaction record.

When the detailed transaction is logged, the transient


data request data can optionally be included or excluded
from the record.

The following related options are required:

TRANSACTION-DATA Yes
TRANSACTION-DATA-TDATA Yes

Valid values:

No - Do not include transient data request data

Yes - Include transient data request data

Related options:

TRANSACTION-DATA-TDATA

-----------------------------------------------------------------------

Option : TRANSACTION-RECORD-USERDATA
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.
The CICS data collector can monitor and collect detailed
information about user data that has been supplied using
the SYSVIEW Monitor Exit Interface (MEI).

The data is recorded historically as segment data in the


detailed transaction record.

When the detailed transaction is logged, the user data


can optionally be included or excluded from the record.

The following related options are required:

TRANSACTION-DATA Yes
TRANSACTION-DATA-USERDATA Yes

Valid values:

No - Do not include user data

Yes - Include user data

-----------------------------------------------------------------------

Option : TRANSACTION-RECORD-WEBMQ
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

The CICS data collector can monitor and collect detailed


information about IBM MQ requests made by transactions.

The data is recorded historically as segment data in the


detailed transaction record.

When the detailed transaction is logged, the IBM MQ


request data can optionally be included or excluded from
the record.

The following related options are required:

TRANSACTION-DATA Yes
TRANSACTION-DATA-WEBMQ Yes

Valid values:

No - Do not include IBM MQ request data

Yes - Include IBM MQ request data

Related options:

TRANSACTION-DATA-WEBMQ

-----------------------------------------------------------------------

Option : TRANSACTION-SUMMARY-STATS
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.
Specify if transaction summary information should be collected
for TSUMxxxx metrics. This information can be displayed
using the online command CSTATUS.

Valid values:

Yes - Data collection for transaction summary


metrics (TSUMxxxx) will be dynamically
added and updates as transaction IDs are
used for the first time.

No - Data collection for transaction summary


metrics (TSUMxxxx) will not be added.

-----------------------------------------------------------------------

Option : VSTATUS-COLLECTION
Default : Yes

Change : This option can be modified after initialization


via the CCONFIG or CICSSET commands.

Specify if variable resource status collection is to be


active. Short term historical data is collected for real-time
graphical presentation.

Valid values:

Yes - Collection will be performed.

No - Collection will not be performed.

Related options:

VSTATUS-MEMBER
VSTATUS-STARTTYPE
VSTATUS-TOTAL-INTERVAL

-----------------------------------------------------------------------

Option : VSTATUS-MEMBER
Default : CICSSTAT

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

Specify the name of the variable status collection member


containing a list of variable and resource names.

Persistent Data Store Information:

The definitions will be maintained and saved as a member


in the persistent data store PDSE data set.

DataId : CICSSTAT_jobname
Size : 480 + ( 80 * definitions )

ReUse : Data will be loaded and reused from matching


builds. Data from previous builds will be
converted and reused automatically.
The data from the persistent data store will
only be used if all of the following are
true. Otherwise, data definitions will be
read from the parmlib member specified by
the option: VSTATUS-MEMBER

* The CICS data collector start mode was WARM

CICS SIT parameter:

INITPARM=(GSVCGSVS='START=WARM')

GSVS initialization transaction:

GSVS START=WARM

* Configuration option:
VSTATUS-STARTTYPE WARM

Migration : Data members from previous builds can be


deleted if that product build is no longer
being used.

Related options:

VSTATUS-COLLECTION
VSTATUS-STARTTYPE
VSTATUS-TOTAL-INTERVAL

-----------------------------------------------------------------------

Option : VSTATUS-STARTTYPE
Default : Warm

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

Specifies the start mode of the variable status component.

Valid values:

Warm - Warm start


Definitions will be retrieved from the
persistent data store.

Cold - Cold start


Definitions will be read from the parmlib
defined by the option: VSTATUS-MEMBER

This value can be overridden during SYSVIEW startup in CICS.


For more information on StartMode see:

CICS data collection start mode

Related options:

VSTATUS-COLLECTION
VSTATUS-MEMBER
VSTATUS-TOTAL-INTERVAL
-----------------------------------------------------------------------

Option : VSTATUS-TOTAL-INTERVAL
Default : 1

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

Specify the variable status data collection interval, in hours.


Data for each interval is presented in 60 segments,
regardless of the length of the interval. For example, if the
interval is 1 hour, each segment is 1 minute; if the interval is 4
hours, each segment is 4 minutes. The amount of storage and
overhead required is the same regardless of the length of the
interval.

Valid values:

Minimum - 1

Maximum - 24

Related options:

VSTATUS-COLLECTION
VSTATUS-MEMBER
VSTATUS-STARTTYPE

-----------------------------------------------------------------------

Option : ZIIP-ENABLE
Default : Yes

Change : This option can only be set during initialization


via the SVWCOPTS parmlib member.

Controls whether or not eligible workload is to be scheduled for


dispatching on a zIIP processor.

Valid values:

Yes - Enable the usage of zIIP processors.

No - Disable the usage of zIIP processors.

-----------------------------------------------------------------------

CICS Time Series Data Configuration Options

-----------------------------------------------------------------------

Option : CICS-Connection
Default : Enable

Change : This option can be modified after initialization using the


CTSDSTAT, CCONFIG or CICSSET commands.

The CICS data collector is a provider of time series data to


subscribers.

This option controls whether subscriptions to CICS remote connection


data will be honored and provided.

The following related options are required:

Time-Series-Data Enable

Statistical information for the collection of data can be viewed


and managed using the online command: CTSDSTAT

Valid values:

Enable - Time series data will be sent to subscribers.

Disable - Time series data will not be sent to subscribers.

-----------------------------------------------------------------------

Option : CICS-File
Default : Enable

Change : This option can be modified after initialization using the


CTSDSTAT, CCONFIG or CICSSET commands.

The CICS data collector is a provider of time series data to


subscribers.

This option controls whether subscriptions to CICS files


data will be honored and provided.

The following related options are required:

Time-Series-Data Enable

Statistical information for the collection of data can be viewed


and managed using the online command: CTSDSTAT

Valid values:

Enable - Time series data will be sent to subscribers.

Disable - Time series data will not be sent to subscribers.

-----------------------------------------------------------------------

Option : CICS-JvmServer
Default : Enable

Change : This option can be modified after initialization using the


CTSDSTAT, CCONFIG or CICSSET commands.

The CICS data collector is a provider of time series data to


subscribers.

This option controls whether subscriptions to CICS JVM server


data will be honored and provided.

The following related options are required:

Time-Series-Data Enable

Statistical information for the collection of data can be viewed


and managed using the online command: CTSDSTAT

Valid values:

Enable - Time series data will be sent to subscribers.

Disable - Time series data will not be sent to subscribers.

-----------------------------------------------------------------------

Option : CICS-Region
Default : Enable

Change : This option can be modified after initialization using the


CTSDSTAT, CCONFIG or CICSSET commands.

The CICS data collector is a provider of time series data to


subscribers.

This option controls whether subscriptions to CICS region data


will be honored and provided.

The following related options are required:

Time-Series-Data Enable

Statistical information for the collection of data can be viewed


and managed using the online command: CTSDSTAT

Valid values:

Enable - Time series data will be sent to subscribers.

Disable - Time series data will not be sent to subscribers.

-----------------------------------------------------------------------

Option : CICS-Socket
Default : Enable

Change : This option can be modified after initialization using the


CTSDSTAT, CCONFIG or CICSSET commands.

The CICS data collector is a provider of time series data to


subscribers.

This option controls whether subscriptions to CICS socket data


will be honored and provided.

The following related options are required:

Time-Series-Data Enable

Statistical information for the collection of data can be viewed


and managed using the online command: CTSDSTAT

Valid values:

Enable - Time series data will be sent to subscribers.

Disable - Time series data will not be sent to subscribers.


-----------------------------------------------------------------------

Option : CICS-TcbPool
Default : Enable

Change : This option can be modified after initialization using the


CTSDSTAT, CCONFIG or CICSSET commands.

The CICS data collector is a provider of time series data to


subscribers.

This option controls whether subscriptions to CICS TCB pool


data will be honored and provided.

The following related options are required:

Time-Series-Data Enable

Statistical information for the collection of data can be viewed


and managed using the online command: CTSDSTAT

Valid values:

Enable - Time series data will be sent to subscribers.

Disable - Time series data will not be sent to subscribers.

-----------------------------------------------------------------------

Option : CICS-TClass
Default : Enable

Change : This option can be modified after initialization using the


CTSDSTAT, CCONFIG or CICSSET commands.

The CICS data collector is a provider of time series data to


subscribers.

This option controls whether subscriptions to CICS transaction


class data will be honored and provided.

The following related options are required:

Time-Series-Data Enable

Statistical information for the collection of data can be viewed


and managed using the online command: CTSDSTAT

Valid values:

Enable - Time series data will be sent to subscribers.

Disable - Time series data will not be sent to subscribers.

-----------------------------------------------------------------------

Option : CICS-TData
Default : Enable

Change : This option can be modified after initialization using the


CTSDSTAT, CCONFIG or CICSSET commands.

The CICS data collector is a provider of time series data to


subscribers.

This option controls whether subscriptions to CICS transient data


information will be honored and provided.

The following related options are required:

Time-Series-Data Enable

Statistical information for the collection of data can be viewed


and managed using the online command: CTSDSTAT

Valid values:

Enable - Time series data will be sent to subscribers.

Disable - Time series data will not be sent to subscribers.

-----------------------------------------------------------------------

Option : CICS-Tran
Default : Enable

Change : This option can be modified after initialization using the


CTSDSTAT, CCONFIG or CICSSET commands.

The CICS data collector is a provider of time series data to


subscribers.

This option controls whether subscriptions to CICS transaction


degradation analysis data will be honored and provided.

The following related options are required:

Time-Series-Data Enable

Statistical information for the collection of data can be viewed


and managed using the online command: CTSDSTAT

Valid values:

Enable - Time series data will be sent to subscribers.

Disable - Time series data will not be sent to subscribers.

-----------------------------------------------------------------------

Option : Time-Series-Data
Default : Enable

Change : This option can be modified after initialization using the


CCONFIG or CICSSET commands.

The CICS data collector is a provider of time series data to


subscribers.

Valid values:
Enable - Time series data will be sent to subscribers.

Disable - Time series data will not be sent to subscribers.


This option can be used as a "main switch"
to disable all time series collections.

-----------------------------------------------------------------------
CCONN

CCONN Command

The CCONN command displays information about CICS connections


and facilities. The current status of a connection and possible
connection configuration information is available.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CCONN | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Connection,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Connection | The connection name. |
| | Possible values are: |
| | DBCTL |
| | DB2 |
| | TCP/IP |
| | VTAM |
| | MQ |
| | WEB |
+------------------+--------------------------------------------------+
| Status | The current status of the connection. |
+------------------+--------------------------------------------------+
| Data1 | The "Data1" value is dependent and different |
| | for each connection. |
| | |
| | Connection "Data1" value |
| | ---------------- ------------------------------- |
| | DBCTL The suffix of the startup table |
| | DB2 Connection name |
| | TCP/IP n/a |
| | VTAM VTAM applid |
| | MQ Queue manager |
| | WEB n/a |
| | |
+------------------+--------------------------------------------------+
| Data2 | The "Data2" value is dependent and different |
| | for each connection. |
| | |
| | Connection "Data2" value |
| | ---------------- ------------------------------- |
| | DBCTL The DBCTL subsystem ID |
| | DB2 The DB2 subsystem ID |
| | TCP/IP n/a |
| | VTAM n/a |
| | MQ The default intiation queue |
| | WEB n/a |
| | |
+------------------+--------------------------------------------------+
| Metric | Associated data collection metric name. |
+------------------+--------------------------------------------------+
| MetAlias | Associated data collection metric alias name. |
+------------------+--------------------------------------------------+
| Description | A description of the metric name. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the MOREINFO command for the selected |
| | metric name. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CCONTAIN

CCONTAIN Command

The CCONTAIN command displays information about data that is


stored in channel containers.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CCONTAIN | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,


Tran,A,Task#,A,Program,A,Channel,A,Container,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Tran | The CICS transaction ID |
+------------------+--------------------------------------------------+
| Task# | The CICS transaction or task number |
+------------------+--------------------------------------------------+
| Program | The program name at the current program level |
+------------------+--------------------------------------------------+
| Channel | The channel name |
+------------------+--------------------------------------------------+
| Container | The container name |
+------------------+--------------------------------------------------+
| Size | The length of the data in the container. |
+------------------+--------------------------------------------------+
| ChanType | The channel type. |
| | Possible values are: |
| | TRAN - Owned by the transaction |
| | PROGRAM - Owned by the program |
+------------------+--------------------------------------------------+
| Type | The container type. |
| | Possible values are: |
| | CICS |
| | USER |
+------------------+--------------------------------------------------+
| DataType | The container data type. |
| | Possible values are: |
| | blank - data type not specified |
| | CHAR - data type is character |
| | BIT - data type is BIT |
+------------------+--------------------------------------------------+
| UserAcc | The user access of the container. |
| | Possible values are: |
| | READONLY |
| | ANY |
+------------------+--------------------------------------------------+
| GCDSA | The amount of above the bar storage used to hold |
| | the data segment. |
+------------------+--------------------------------------------------+
| CodeP | The default code page. |
+------------------+--------------------------------------------------+
| DataAddress | The address of the data segment. |
+------------------+--------------------------------------------------+
| Char-Data | The first 32 bytes of data at the data address |
| | displayed in character format. |
+------------------+--------------------------------------------------+
| Hex-Data | The first 16 bytes of data at the data address |
| | displayed in hexadecimal format. |
+------------------+--------------------------------------------------+
| Write | The number of writes to this container. |
| | A generation sequence number. |
+------------------+--------------------------------------------------+
| Browse | The number of browses on this container. |
+------------------+--------------------------------------------------+
| TXN | Specifies the address of the TXn control block |
| | in CICS. |
+------------------+--------------------------------------------------+
| PLCB | The address of the Program Level Control Block. |
+------------------+--------------------------------------------------+
| CHCB | The address of the CHCB control block. |
+------------------+--------------------------------------------------+
| CPCB | The address of the CPCB control block. |
+------------------+--------------------------------------------------+
| CRCB | The address of the CRCB control block. |
+------------------+--------------------------------------------------+
| CSCB | The address of the CSCB control block. |
+------------------+--------------------------------------------------+
| CSDB | The address of the CSDB control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| SELECT | Invokes the SNAP command to display the selected |
| | data segment. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CDATAMON

CDATAMON Command

The CDATAMON display provides information about the SYSVIEW


CICS Data Collection processes.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CDATAMON | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| CPUTime | The amount of CPU time that has been consumed |
| | by the CICS address space since the data |
| | collector was started. |
+------------------+--------------------------------------------------+
| ReqsGLUE | The total number of CICS Global User Exit |
| | requests that have been processed. |
| | For more information see: CGBLEXIT |
+------------------+--------------------------------------------------+
| ElapGLUE | The total elapsed time needed by the |
| | data collector to process the CICS Global User |
| | Exit requests. |
+------------------+--------------------------------------------------+
| CpuGLUE | The total CPU time that has been consumed |
| | by the data collector while processing the |
| | CICS Global User Exit requests. |
+------------------+--------------------------------------------------+
| GLUE% | The percentage of the CICS CPU time used |
| | by the GLUE data collection process. |
| | |
| | glue% = (CpuGLUE * 100) |
| | --------------- |
| | CPUTime |
| | |
+------------------+--------------------------------------------------+
+------------------+--------------------------------------------------+
| CpuSDCS | The total CPU time that has been consumed |
| | by the System data collector. |
| | For more information see: CSYSDMON |
+------------------+--------------------------------------------------+
| SDCS% | The percentage of the CICS CPU time used |
| | by the System data collection process. |
| | |
| | SDCS% = (CpuSDCS * 100) |
| | --------------- |
| | CPUTime |
| | |
+------------------+--------------------------------------------------+
| CpSDCS | The amount of CPU time that has been consumed |
| | by the System data collector on a CP. |
+------------------+--------------------------------------------------+
| EnclSDCS | The amount of CPU time that has been consumed |
| | by the System data collector in an enclave. |
+------------------+--------------------------------------------------+
| eSDCS% | The percent of the total CPU time used |
| | by the System data collector that executed |
| | on an enclave. |
| | |
| | eSDCS% = EnclSDCS * 100 |
| | --------------------- |
| | CpuSDCS |
| | |
+------------------+--------------------------------------------------+
+------------------+--------------------------------------------------+
| ReqsXDIS | The total number of External Data Interface |
| | requests that have been processed. |
+------------------+--------------------------------------------------+
| CpuXDIS | The total CPU time that has been consumed |
| | by the External Data Interface task. |
+------------------+--------------------------------------------------+
| XDIS% | The percentage of the CICS CPU time used |
| | by the External Data Interface task. |
| | |
| | XDIS% = (CpuXDIS * 100) |
| | --------------- |
| | CPUTime |
| | |
+------------------+--------------------------------------------------+
| CpXDIS | The amount of CPU time that has been consumed |
| | by the External Data Interface task on a CP. |
+------------------+--------------------------------------------------+
| EnclXDIS | The amount of CPU time that has been consumed |
| | by the External Data Interface task in an |
| | enclave. |
+------------------+--------------------------------------------------+
| eXDIS% | The percent of the total CPU time used |
| | by the External Data Interface task that |
| | executed on an enclave. |
| | |
| | eXDIS% = EnclXDIS * 100 |
| | --------------------- |
| | CpuXDIS |
| | |
+------------------+--------------------------------------------------+
+------------------+--------------------------------------------------+
| CpuSCHT | The total CPU time that has been consumed |
| | by the scheduler. |
+------------------+--------------------------------------------------+
| SCHT% | The percentage of the CICS CPU time used |
| | by the scheduler process. |
| | |
| | SCHT% = (CpuSCHT * 100) |
| | --------------- |
| | CPUTime |
| | |
+------------------+--------------------------------------------------+
| CpSCHT | The amount of CPU time that has been consumed |
| | by the scheduler task on a CP. |
+------------------+--------------------------------------------------+
| EnclSCHT | The amount of CPU time that has been consumed |
| | by the Scheduler task in an exclave. |
+------------------+--------------------------------------------------+
| eSCHT% | The percent of the total CPU time used |
| | by the Scheduler task that executed on an |
| | enclave. |
| | |
| | eSCHT% = EnclSCHT * 100 |
| | --------------------- |
| | CpuSCHT |
| | |
+------------------+--------------------------------------------------+
+------------------+--------------------------------------------------+
| CpuTPPT | The total CPU time that has been consumed |
| | by the transaction post processor task. |
+------------------+--------------------------------------------------+
| TPPT% | The percentage of the CICS CPU time used |
| | by the transaction post processor task. |
| | |
| | TPPT% = (CpuTPPT * 100) |
| | --------------- |
| | CPUTime |
| | |
+------------------+--------------------------------------------------+
| CpTPPT | The amount of CPU time that has been consumed |
| | by the transaction post processor task on a CP. |
+------------------+--------------------------------------------------+
| EnclTPPT | The amount of CPU time that has been consumed |
| | by the transaction post processor task on an |
| | enclave. |
+------------------+--------------------------------------------------+
| eTPPT% | The percent of the total CPU time used |
| | by the transaction post processor task on an |
| | enclave. |
| | |
| | eTPPT% = EnclTPPT * 100 |
| | --------------------- |
| | CpuTPPT |
| | |
+------------------+--------------------------------------------------+
+------------------+--------------------------------------------------+
| CpuLOGT | The total CPU time that has been consumed |
| | by the message logger task. |
+------------------+--------------------------------------------------+
| LOGT% | The percentage of the CICS CPU time used |
| | by the message logger task. |
| | |
| | LOGT% = (CpuLOGT * 100) |
| | --------------- |
| | CPUTime |
| | |
+------------------+--------------------------------------------------+
| CpLOGT | The amount of CPU time that has been consumed |
| | by the message logger task on a CP. |
+------------------+--------------------------------------------------+
| EnclLOGT | The amount of CPU time that has been consumed |
| | by the message logger task on an enclave. |
+------------------+--------------------------------------------------+
| eLOGT% | The percent of the total CPU time used |
| | by the message logger task on an enclave. |
| | |
| | eLOGT% = EnclLOGT * 100 |
| | --------------------- |
| | CpuLOGT |
| | |
+------------------+--------------------------------------------------+
+------------------+--------------------------------------------------+
| EnclTime | The amount of CPU time that has been consumed |
| | by the CICS address space since the data |
| | collector was started in an enclave. |
+------------------+--------------------------------------------------+
| ePct% | The percent of the total CPU time used that |
| | executed on an enclave. |
| | |
| | ePct% = EnclTime * 100 |
| | --------------------- |
| | CPUTime |
| | |
+------------------+--------------------------------------------------+
| ElapGSVI | The elapsed time since the data collector |
| | was started. |
+------------------+--------------------------------------------------+
| DateGSVI | The date and time that the CICS data collector |
| TimeGSVI | was started. |
+------------------+--------------------------------------------------+
| ElapCICS | The elapsed time since the CICS region was |
| | started. |
+------------------+--------------------------------------------------+
| DateCICS | The date and time that the CICS was started. |
| TimeCICS | |
+------------------+--------------------------------------------------+
| GPvtLim | The maximum amount of grande storage that can |
| | be allocated and internally managed. |
+------------------+--------------------------------------------------+
| GPvtSize | The current amount of grande storage that has |
| | been allocated from MVS and is being internally |
| | managed. |
+------------------+--------------------------------------------------+
| GPvtExt | The number of allocations of grande storage |
| | that have been allocated to MVS. |
+------------------+--------------------------------------------------+
| GPvtPri | The primary grande storage allocation size. |
+------------------+--------------------------------------------------+
| GPvtSec | The secondary grande storage allocation size. |
+------------------+--------------------------------------------------+
| AllocSize | The amount of storage currently allocated or |
| | in use. |
+------------------+--------------------------------------------------+
| AllocHWM | The high watermark of allocated storage. |
+------------------+--------------------------------------------------+
| AllocCnt | The number of allocated storage blocks. |
+------------------+--------------------------------------------------+
| FreeSize | The amount of storage currently free or |
| | available for use. |
+------------------+--------------------------------------------------+
| FreeMax | The maximum contiguous block of free storage. |
+------------------+--------------------------------------------------+
| FreeCnt | The number of free storage blocks. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the CREVIEW command to display |
| | interval statistics. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CDATATBL

CDATATBL Command

The CDATATBL command displays statistics and definition information for


CICS files defined as data tables since the last CICS statistics reset.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CDATATbl | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Filename,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Filename | The name of the file defined to CICS. |
+------------------+--------------------------------------------------+
| Type | The data table type. |
| | |
| | Possible values are: |
| | |
| | CICS CICS managed data table |
| | USER User managed data table |
| | CF Coupling Facility data table |
| | RMTE Remote data table |
+------------------+--------------------------------------------------+
| OpenStatus | The file status. |
| | |
| | Possible values are: |
| | |
| | OPEN |
| | CLOSED |
+------------------+--------------------------------------------------+
| EnaStatus | The file enabled or disabled status. |
| | |
| | Possible values are: |
| | |
| | ENABLED - The file is enabled |
| | DISABLED - The file is disabled |
| | UNENABLE - The file is unenabled |
+------------------+--------------------------------------------------+
| FileType | The file type. |
| | |
| | Possible values are: |
| | |
| | RMTE Remote file |
| | KSDS VSAM KSDS |
| | ESDS VSAM ESDS |
| | RRDS VSAM RRDS |
| | VSAM VSAM (specific type not known) |
| | BDAM BDAM |
+------------------+--------------------------------------------------+
| ReadSucc | The number of successful attempts to retrieve |
| | records from the table. |
+------------------+--------------------------------------------------+
| RecNotFnd | The number of API READ requests that were |
| | directed to the source data set because the |
| | record was not found in the table. |
+------------------+--------------------------------------------------+
| AddsRead | The number of records placed in the table by the |
| | loading process or from API READ requests issued |
| | while loading was in progress. |
+------------------+--------------------------------------------------+
| AddsAPI | The number of attempts to add records via WRITE |
| | requests. |
+------------------+--------------------------------------------------+
| AddsRej | The number of records that were attempted to be |
| | added, but were rejected by the global user exit.|
+------------------+--------------------------------------------------+
| AddsFull | The number of records that were attempted to be |
| | added, but the table already contained the |
| | maximum number of records. |
+------------------+--------------------------------------------------+
| Rewrites | The number of REWRITE requests. |
+------------------+--------------------------------------------------+
| Deletes | The number of DELETE requests. |
+------------------+--------------------------------------------------+
| Records | The number of records. |
+------------------+--------------------------------------------------+
| RecsHWM | High water mark of the number of records. |
+------------------+--------------------------------------------------+
| DataUsed | The amount of storage used for record data. |
+------------------+--------------------------------------------------+
| DataAlloc | The amount of storage allocated for record data. |
+------------------+--------------------------------------------------+
| Pct% | The percentage of storage used for record data. |
+------------------+--------------------------------------------------+
| TableName | The name of the coupling facility data table. |
+------------------+--------------------------------------------------+
| PoolName | The name of the coupling facility data table |
| | pool containing the table. |
+------------------+--------------------------------------------------+
| Load | The load type. |
| | |
| | Possible values are: |
| | |
| | LOAD Data table loaded |
| | blank Data table not loaded |
+------------------+--------------------------------------------------+
| UpdateModel | The model used for updating records. |
| | |
| | Possible values are: |
| | |
| | CONTENTION Records are not locked during |
| | update |
| | LOCKING Records are locked during update |
+------------------+--------------------------------------------------+
| FwdRcv | Indicates if forward recovery is enabled. |
| | |
| | Possible values are: |
| | |
| | FWDRCV Forward recovery enabled |
| | blank Forward recovery disabled |
+------------------+--------------------------------------------------+
| JrnlID | The journal ID for automatic journaling of |
| | messages. |
+------------------+--------------------------------------------------+
| LSR | The Local Resource pool number. |
| | If the file is not assigned to an LSR pool then |
| | this field is blank. |
+------------------+--------------------------------------------------+
| FileAdds | The number of add requests. |
+------------------+--------------------------------------------------+
| FileBrws | The number of browse requests. |
+------------------+--------------------------------------------------+
| FileDel | The number of delete requests. |
+------------------+--------------------------------------------------+
| FileRead | The number of read requests. |
+------------------+--------------------------------------------------+
| FileRUpd | The number of read for update requests. |
+------------------+--------------------------------------------------+
| FileUpd | The number of update requests. |
+------------------+--------------------------------------------------+
| DataExcp | The number of data operation exceptions. |
+------------------+--------------------------------------------------+
| DataBuff | The data buffer count. |
+------------------+--------------------------------------------------+
| IdxBuff | The index buffer count. |
+------------------+--------------------------------------------------+
| Strings | The upper string limit. |
+------------------+--------------------------------------------------+
| StrAct | The number of active strings. |
+------------------+--------------------------------------------------+
| StrWait | The current number of string waits. |
+------------------+--------------------------------------------------+
| StrWaitT | The total number of string waits. |
+------------------+--------------------------------------------------+
| Add | The file capabilities. |
| | |
| | Possible values are: |
| | |
| | ADD Add requests are supported |
| | blank Add requests are NOT supported |
+------------------+--------------------------------------------------+
| Bro | The file capabilities. |
| | |
| | Possible values are: |
| | |
| | BRO Browse requests are supported |
| | blank Browse requests are NOT supported |
+------------------+--------------------------------------------------+
| Del | The file capabilities. |
| | |
| | Possible values are: |
| | |
| | DEL Delete requests are supported |
| | blank Delete requests are NOT supported |
+------------------+--------------------------------------------------+
| Read | The file capabilities. |
| | |
| | Possible values are: |
| | |
| | READ Read requests are supported |
| | blank Read requests are NOT supported |
+------------------+--------------------------------------------------+
| Upd | The file capabilities. |
| | |
| | Possible values are: |
| | |
| | UPD Update requests are supported |
| | blank Update requests are NOT supported |
+------------------+--------------------------------------------------+
| KeyLen | The length of the key. This field is only valid |
| | for FileType KSDS. |
+------------------+--------------------------------------------------+
| KeyPos | The position of the key. This field is only |
| | valid for FileType KSDS. |
+------------------+--------------------------------------------------+
| RecSize | The record size of the file. |
+------------------+--------------------------------------------------+
| OpenDate | The date and time the file was opened. |
| OpenTime | |
+------------------+--------------------------------------------------+
| Disp | The data set disposition. |
+------------------+--------------------------------------------------+
| Volser | The volser of the data set, if available. |
+------------------+--------------------------------------------------+
| DataSetName | The data set name, if available. |
+------------------+--------------------------------------------------+
| DefDate | The date and time when the definition was |
| DefTime | created. |
+------------------+--------------------------------------------------+
| DefGroup | The name of the definition group from where |
| | the entry was installed. |
+------------------+--------------------------------------------------+
| InstAgent | The agent that installed the definition. |
+------------------+--------------------------------------------------+
| InstDate | The date and time when the definition was |
| InstTime | installed. |
+------------------+--------------------------------------------------+
| InstUser | The userid that installed the definition. |
+------------------+--------------------------------------------------+
| ChgAgent | The agent that changed the definition. |
+------------------+--------------------------------------------------+
| ChgLvl | The CICS release of the agent that changed the |
| | definition. |
+------------------+--------------------------------------------------+
| ChgDate | The date and time when the definition was last |
| ChgTime | changed. |
+------------------+--------------------------------------------------+
| ChgUser | The userid that changed the definition. |
+------------------+--------------------------------------------------+
| DFHFCTDS | The address of the File Control Table entry. |
+------------------+--------------------------------------------------+
| FCTDTTKN | The data table token. |
+------------------+--------------------------------------------------+
| FCTDTPTH | The data table path token. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Close | Issues a close request for the selected file. |
+------------------+--------------------------------------------------+
| DISable | Issues a disable request for the selected file. |
+------------------+--------------------------------------------------+
| ENAble | Issues an enable request for the selected file. |
+------------------+--------------------------------------------------+
| Open | Issue an open request for the selected file. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| ENQueue | Invokes the ENQUEUES command. Selection is |
| | performed as follows: |
| | |
| | SELECT RNAME EQ dataset.name= |
+------------------+--------------------------------------------------+
| LC | Invokes the IDCAMS LISTCAT command for the |
| | selected data set. |
+------------------+--------------------------------------------------+
| Select | A detailed display of the FCT entry. |
+------------------+--------------------------------------------------+
| Use | Invokes the CFILEUSE command selecting the |
| | filename to show the transactions that are |
| | currently using the file. |
+------------------+--------------------------------------------------+
| VToc | Invokes the VTOC command for the selected |
| | data set. |
+------------------+--------------------------------------------------+
| XTents | Invokes the EXTENTS command for the selected |
| | data set. |
+------------------+--------------------------------------------------+

Subcommands
+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CDATATBL command security


CDBCTL

CDBCTL Command

The CDBCTL command shows information and statistics about the


CICS connection to an IMS DB Control region.

The CICS supplied CDBC transaction can be used to display a menu


to connect to and disconnect from DBCTL.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CDBCTL | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,ID,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Id | The DBCTL identifier. This is the IMS subsystem |
| | id of the IMS DB Control region. |
+------------------+--------------------------------------------------+
| Status | The connection status. |
| | Possible values are: |
| | |
| | CONNECT-P1 |
| | CONNECT-P2 |
| | CONNECTED |
| | DISCONN-ORD |
| | DISCONN-IMM |
| | DISCONNECTED |
| | NONE |
| | UNUSABLE |
| | UNKNOWN |
+------------------+--------------------------------------------------+
| DFSPZPxx | The DRA startup table DFSPZPxx. |
| | "xx" is the DRA startup table suffix. |
+------------------+--------------------------------------------------+
| CRC | The command recognition character for the |
| | DBCTL session. |
+------------------+--------------------------------------------------+
| Session | The CICS DBCTL session number. This number is |
| | incremented each time CICS connects to DBCTL. |
+------------------+--------------------------------------------------+
| Schedules | The number of successful PSB schedule requests |
| | for the current DBCTL session. This number is |
| | reset each time CICS disconnects from DBCTL. |
+------------------+--------------------------------------------------+
| Recalls | The number of DFHRMCAL requests that are active |
| | in the ADAPTER/DRA. |
+------------------+--------------------------------------------------+
| ThrdMin | The minimum number of threads defined in the |
| | DRA startup table. |
+------------------+--------------------------------------------------+
| ThrdMax | The maximum number of threads defined in the |
| | DRA startup table. |
+------------------+--------------------------------------------------+
| CntlTxnA | Address of the Control Txn Area. |
+------------------+--------------------------------------------------+
| DFHDGB | Address of the DFHDGB control block. |
+------------------+--------------------------------------------------+

+---------------------------------------------------------------------+
| The following thread usage values are returned from DBCTL at |
| disconnect and therefore relate to the previous CICS-DBCTL session. |
+------------------+--------------------------------------------------+
| ThrdHWM | The high water mark for the number of threads. |
+------------------+--------------------------------------------------+
| ThrdMinHits | The minimum number of thread hits. |
+------------------+--------------------------------------------------+
| ThrdMaxHits | The maximum number of thread hits. |
+------------------+--------------------------------------------------+
| ThrdElapMax | The elapsed time at maximum threads. |
+------------------+--------------------------------------------------+

+---------------------------------------------------------------------+
| The following information is specific to the connected IMS DBCTL |
| job and not the CICS address space. |
+------------------+--------------------------------------------------+
| JobDBCTL | The connected IMS DBCTL jobname. |
+------------------+--------------------------------------------------+
| Jobnr | The connected IMS DBCTL job number. |
+------------------+--------------------------------------------------+
| JobStat | The status of the connected IMS DBCTL job. |
| | Possible values are: |
| | |
| | NS Nonswappable |
| | LSW Logically swapped |
| | GO OUT Currently being swapped out |
| | GO IN Currently being swapped in |
| | IN Swapped in |
| | OUT TO Swapped out--terminal output wait |
| | OUT TI Swapped out--terminal input wait |
| | OUT LW Swapped out--long wait |
| | OUT XS Swapped out--auxiliary storage |
| | shortage |
| | OUT RS Swapped out--real storage shortage |
| | OUT DW Swapped out--detected wait |
| | OUT RQ Swapped out--requested swap |
| | OUT NQ Swapped out--enqueue exchange swap |
| | OUT EX Swapped out--exchange on recommended |
| | value |
| | OUT US Swapped out--unilateral swap |
| | OUT TS Swapped out--transition swap |
| | OUT IC Swapped out--improve central storage |
| | OUT IP Swapped out--improve system paging |
| | OUT MR Swapped out--make room |
| | OUT AW Swapped out--APPC wait |
| | OUT OI Swapped out--input wait |
| | OUT OO Swapped out--output wait |
| | OUT LS Swapped out--logical swap |
| | OUT LF Swapped out--logical swap fail |
| | OUT SR Swapped out--real swap |
| | blank No address space found with the |
| | specified jobname |
+------------------+--------------------------------------------------+
| Stepname | The current stepname of the connected IMS DBCTL |
| | job. Stepnames are displayed only for jobs that |
| | have a stepname coded in the JCL. |
+------------------+--------------------------------------------------+
| Procname | The current procedure stepname of the connected |
| | IMS DBCTL job. |
| | Procedure stepnames are displayed only for jobs |
| | that use a PROC statement in the JCL. |
+------------------+--------------------------------------------------+
| Type | The type of connected IMS DBCTL job. |
| | Possible values are: |
| | |
| | JOB A batch job |
| | SYS A system task |
| | STC A started task |
| | TSU A TSO user |
| | INI An initiator |
| | ATX An APPC transaction |
| | OTX An OpenMVS transaction |
+------------------+--------------------------------------------------+
| JobClass | The input class of the connected IMS DBCTL job. |
+------------------+--------------------------------------------------+
| ASID | The hexadecimal address space ID of the |
| | connected IMS DBCTL job. |
+------------------+--------------------------------------------------+
| ASCB | The ASCB address for the connected IMS DBCTL job.|
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CDB2CONN

CDB2CONN Command

The CDB2CONN command displays the global state information for


the current CICS-Db2 connection. A DB2CONN RDO object is
required to operate the CICS-Db2 Attachment facility.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CDB2CONN | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Job name |
+------------------+--------------------------------------------------+
| DB2Conn | The name of the installed DB2 connection |
+------------------+--------------------------------------------------+
| DB2 | The name of the Db2 subsystem that the CICS |
| | Db2 attachment is connected to or will attempt |
| | to connect. If a Db2 group is specified, this |
| | is the Db2 subsystem that will be connected. |
+------------------+--------------------------------------------------+
| Group | The name of the data sharing group of Db2 |
| | subsystems. CICS will connect to any active |
| | member of this group. |
+------------------+--------------------------------------------------+
| Release | The version and release level of the Db2 |
| | that is currently connected. |
+------------------+--------------------------------------------------+
| AttStatus | CICS attachment status |
| | |
| | Possible values are: |
| | ACCMAINT - Db2 is in access(maint) |
| | DFHD2MSB - DFHDB2MSB is active |
| | INACTIVE - Attachment is inactive |
| | RESTART - Db2 is restart light |
| | RESYNC - CEX2 to issue resync |
| | STANDBY - Attach is in standby |
| | STARTED - CEX2 has started |
| | TERMINATE - CEX2 should terminate |
| | |
+------------------+--------------------------------------------------+
| ConnStatus | The current status of the Db2 connection. |
| | |
| | Possible values are: |
| | |
| | CONNECTED |
| | CONNECTING |
| | DISCONNECTING |
| | DISCONNECTED |
| | |
+------------------+--------------------------------------------------+
| TCBs | The current number of TCBs used by the CICS |
| | Db2 attachment facility. |
+------------------+--------------------------------------------------+
| TCBHWM | TCB high water mark |
+------------------+--------------------------------------------------+
| TCBLim | The maximum number of TCBs that can be used |
| | to process Db2 requests. |
+------------------+--------------------------------------------------+
| Threads | The current number of active pool threads. |
+------------------+--------------------------------------------------+
| ThreadHWM | The high water mark of active pool threads. |
+------------------+--------------------------------------------------+
| ThreadLim | The maximum number of pool threads that the |
| | Db2 attachment allows to be active before |
| | requests will wait or be rejected. |
| | |
| | See ThreadWait |
| | |
+------------------+--------------------------------------------------+
| Plan | The name of the plan used for the pool. |
+------------------+--------------------------------------------------+
| PlanExit | The name of the dynamic plan exit used for pool |
| | threads. |
+------------------+--------------------------------------------------+
| Pri | The priority of the pool thread TCBs relative |
| | to the main CICS TCB (QR). Db2 threads are |
| | CICS open L8 TCBs. |
| | |
| | Possible values are: |
| | HIGH - Thread TCBs have a higher priority |
| | than the CICS QR TCB. |
| | EQUAL - Thread TCBs have equal priority with |
| | the QR TCB. |
| | LOW - Thread TCBs have a lower priority |
| | than the QR TCB. |
| | |
+------------------+--------------------------------------------------+
| AcctRec | The minimum amount of DB2 accounting required |
| | for transactions using pool threads. |
| | |
| | Possible values are: |
| | UOW - An accounting record will be |
| | produced for each UOW. |
| | TASK - A minimum of one accounting record |
| | will be produced for each CICS task. |
| | TXID - An accounting record will be produced |
| | when the transaction ID that is using |
| | the thread changes. |
| | NONE - No accounting records are required |
| | for transactions using pool threads. |
| | At least one accounting record will be |
| | produced when the thread ends. |
| | |
+------------------+--------------------------------------------------+
| AuthID | The ID used for security checking when using |
| | pool threads. |
+------------------+--------------------------------------------------+
| AuthType | The type of ID used for security checking when |
| | using pool threads. If AuthType is specified, |
| | AuthID will be blank. |
| | |
| | Possible values are: |
| | GROUP - The usedid and the connected group |
| | name are used as the authorization |
| | ID. |
| | OPID - The user operator ID associated |
| | with the transaction userid is |
| | used as the authorization ID. |
| | SIGNID - The SignID of the connection is |
| | used as the authorization ID. |
| | TERM - The terminal ID is used for |
| | the authorization ID. |
| | TXID - The transaction ID is used for the |
| | authorization ID. |
| | USERID - The userid associated with the |
| | transaction is used as the |
| | authorization ID. |
| | |
+------------------+--------------------------------------------------+
| DRollback | Indicates if the Db2 attachment facility is to |
| | initiate a sync point rollback if the |
| | transaction is affected by a deadlock |
| | resolution. |
| | |
| | Possible values are: |
| | ROLLBACK - The attachment facility issues |
| | a sync point rollback before |
| | returning control to the |
| | application. |
| | blank - No rollback is initiated. |
| | |
+------------------+--------------------------------------------------+
| ComThrds | Current number of active command threads |
+------------------+--------------------------------------------------+
| ComThrdHWM | The high water mark of active command threads. |
+------------------+--------------------------------------------------+
| ComThrdLim | The maximum number of command threads that can |
| | be active before requests overflow to the pool. |
+------------------+--------------------------------------------------+
| ComAuthID | The ID used for security checking when using |
| | command threads. |
+------------------+--------------------------------------------------+
| ComAuthType | The type of ID used for security checking when |
| | using command threads. If ComAuthType is |
| | specified, ComAuthID will be blank. |
| | |
| | Possible values are: |
| | GROUP - The usedid and the connected group |
| | name are used as the authorization |
| | ID. |
| | OPID - The user operator ID associated |
| | with the transaction userid is |
| | used as the authorization ID. |
| | SIGNID - The SignID of the connection is |
| | used as the authorization ID. |
| | TERM - The terminal ID is used for |
| | the authorization ID. |
| | TXID - The transaction ID is used for the |
| | authorization ID. |
| | USERID - The userid associated with the |
| | transaction is used as the |
| | authorization ID. |
| | |
+------------------+--------------------------------------------------+
| MsgQ1 | The name of the first transient data queue |
| | destination to which unsolicited messages |
| | from the Db2 attachment are sent. |
+------------------+--------------------------------------------------+
| MsgQ2 | The name of the second transient data queue |
| | destination to which unsolicited messages |
| | from the Db2 attachment are sent. |
+------------------+--------------------------------------------------+
| MsgQ3 | The name of the third transient data queue |
| | destination to which unsolicited messages |
| | from the Db2 attachment are sent. |
+------------------+--------------------------------------------------+
| StatQ | The transient data queue for Db2 attachment |
| | statistics produced when the attachment facility |
| | is shut down. |
+------------------+--------------------------------------------------+
| Standby | The action to be taken by the Db2 attachment |
| | if Db2 is not active when an attempt is made |
| | to connect. |
| | |
| | Possible values are: |
| | CONNECT - The CICS Db2 attachment goes |
| | into standby mode to wait |
| | for Db2. |
| | NOCONNECT - The CICS Db2 attachment ends. |
| | RECONNECT - The CICS Db2 attachment goes |
| | into standby mode to wait |
| | for DB2. After connecting to Db2, |
| | if Db2 fails, the attachment |
| | reverts to standby mode and waits |
| | to connect. |
| | |
+------------------+--------------------------------------------------+
| SignID | The authorization ID used when signing on to |
| | Db2 for pool and Db2 entry threads specifying |
| | AuthType(SIGNID) and command threads specifying |
| | ComAuthType(SIGNID) |
+------------------+--------------------------------------------------+
| ThreadErr | The processing that is to occur following a |
| | create thread error. |
| | |
| | Possible values are: |
| | ABEND - For a second or subsequent SQL error, |
| | the transaction abends. |
| | N906D - A transaction dump is taken. The |
| | DSNCSQL RMI associated with the |
| | transaction is not to be disabled. |
| | The transaction receives a -906 |
| | SQLCODE error if another SQL is |
| | issued, unless the transaction |
| | issues SYNPOINT ROLLBACK. |
| | N906 - The DSNCSQL RMI associated with the |
| | transaction is not to be disabled. |
| | The transaction receives a -906 |
| | SQLCODE error if another SQL is |
| | issued, unless the transaction |
| | issues SYNPOINT ROLLBACK. |
| | |
+------------------+--------------------------------------------------+
| ThreadWait | Indicates whether a transaction will wait for a |
| | pool thread or will be abended if the number of |
| | active pool threads reach the limit. |
| | |
| | Possible values are: |
| | TWAIT - Transaction waits |
| | NOTWAIT - Transaction are abended with code |
| | AD3T. |
| | POOL - Overflow to pool |
| | |
+------------------+--------------------------------------------------+
| ConnErr | Indicates how a transaction is notified if |
| | CICS is not connected to Db2 because the |
| | adapter is in standby mode. |
| | |
| | Possible values are: |
| | SQLCODE - Application receives -923 SQLCODE. |
| | ABEND - Application is abended with AEY9. |
| | |
+------------------+--------------------------------------------------+
| NonTermRel | Indicates whether non-terminal transactions are |
| | to release threads for reuse at intermediate |
| | sync points. |
| | |
| | |
| | Possible values are: |
| | RELEASE - Release threads for reuse |
| | NORELEASE - Do not release threads for reuse |
| | |
+------------------+--------------------------------------------------+
| PurgeCycle | Purge cycle interval. |
| | |
| | A protected thread is not terminated immediately |
| | when it is released. It is terminated only |
| | after two completed purge cycles if it has not |
| | been reused. |
+------------------+--------------------------------------------------+
| Resync | Indicates the methods used if outstanding |
| | units of work are being held for the last |
| | Db2 data sharing group member to which CICS was |
| | connected. |
| | |
| | Only applies if Db2 group attach is in use. |
| | |
| | Possible values are: |
| | RESYNC - Connect to the same Db2 data |
| | sharing group member. |
| | NORESYNC - CICS makes one attempt to connect |
| | to the same Db2 data sharing |
| | group member. If that fails, |
| | CICS connects to any member of |
| | the Db2 data sharing group. |
| | |
+------------------+--------------------------------------------------+
| ReuseLim | The maximum number of times a thread can be |
| | reused before it is terminated. |
+------------------+--------------------------------------------------+
| ConnDate | Connect date and time |
| ConnTime | |
+------------------+--------------------------------------------------+
| DiscDate | Disconnect date and time |
| DiscTime | |
+------------------+--------------------------------------------------+
| DefGroup | CSD Definition group |
+------------------+--------------------------------------------------+
| DFHD2GLB | Address of DFHD2GLB control block |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CDB2CSUB

CDB2CSUB Command

The CDB2CSUB command displays state data for Db2 connection blocks.
Each block is associated with an active Db2 thread.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CDB2CSUB | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Plan,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Plan | The plan name |
+------------------+--------------------------------------------------+
| Status | The status of the connection block. |
| | Valid values are: |
| | AVAILABLE - available for use |
| | IN-DB2 - TCB is in Db2 |
| | RUNNING - Subtask is running |
+------------------+--------------------------------------------------+
| Type | The type portion of the thread correlation ID. |
| | Valid values are: |
| | ENTR |
| | POOL |
| | COMD |
+------------------+--------------------------------------------------+
| Tran | The transaction portion of the thread |
| | correlation ID. This is the CICS transaction ID. |
+------------------+--------------------------------------------------+
| Thrd | The thread portion of the thread correlation ID. |
| | This is a thread number in decimal. |
+------------------+--------------------------------------------------+
| ConnID | The connection ID. |
+------------------+--------------------------------------------------+
| PriAuth | The primary authorization name. |
+------------------+--------------------------------------------------+
| SecAuth | The secondary authorization name. |
+------------------+--------------------------------------------------+
| LastTask | The last or current CICS task number to be |
| | associated with this connection block. |
+------------------+--------------------------------------------------+
| LastReq | The last or current request type. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem ID. |
+------------------+--------------------------------------------------+
| DFHD2CSB | The address of the DFHD2CSB control block. |
+------------------+--------------------------------------------------+
| TCB | The address of the associated MVS TCB. |
+------------------+--------------------------------------------------+
| DFHD2LOT | The address of the DFHD2LOT control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Idb2 | Invoke the IDB2 ( SYSVIEW for Db2 ) command |
| | to display specific information about the |
| | selected thread. |
+------------------+--------------------------------------------------+
| Select | Invoke the DBTHACT command to display specific |
| | information about the selected thread. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CDB2ENTR

CDB2ENTR Command

The CDB2ENTR command displays DB2ENTRY RDO object information.


Each entry contains state data and attributes to be used
by a transaction or a set of transactions when accessing DB2.

Command Syntax

+------------------+--------------------------------------------------+
| CDB2ENTR | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Entry | The entry name. |
+------------------+--------------------------------------------------+
| Plan | The plan name (if specified). |
+------------------+--------------------------------------------------+
| PlanExit | The plan exit name (if specified). |
+------------------+--------------------------------------------------+
| Tran | The specified transaction ID (if any). |
+------------------+--------------------------------------------------+
| AuthID | The authorization ID (if used). |
+------------------+--------------------------------------------------+
| AuthType | The authorization type (if used). Valid values |
| | are: |
| | |
| | GROUP |
| | SIGNID |
| | TERM |
| | TXID |
| | OPID |
| | USERID |
+------------------+--------------------------------------------------+
| Account | The DB2 accounting to be done. Valid values |
| | are: |
| | |
| | UOW |
| | TASK |
| | TXID |
| | NONE |
+------------------+--------------------------------------------------+
| DRollBack | Deadlock rollback. |
+------------------+--------------------------------------------------+
| Priority | The priority of entry threads. Valid values |
| | are: |
| | |
| | HIGH Higher than CICS TCB |
| | EQUAL Equal to CICS TCB |
| | LOW Lower than CICS TCB |
+------------------+--------------------------------------------------+
| ThreadWait | The entry Threadwait setting. Valid values are: |
| | |
| | WAIT Wait for a thread |
| | ABEND Do not wait, abend |
| | OVERFLOW Overflow to the pool |
+------------------+--------------------------------------------------+
| Status | The enable status of DB2ENTRY. Valid values |
| | are: |
| | |
| | DISABLED DB2ENTRY is disabled |
| | DISABLING DB2ENTRY is disabling |
| | ENABLED Enabled |
+------------------+--------------------------------------------------+
| Active | The number of threads active. |
+------------------+--------------------------------------------------+
| ActMax | The maximum number of active threads. |
+------------------+--------------------------------------------------+
| ActHWM | The high water mark of active threads. |
+------------------+--------------------------------------------------+
| Protect | The number of protected threads. |
+------------------+--------------------------------------------------+
| ProtMax | The maximum number of protected threads. |
+------------------+--------------------------------------------------+
| ProtHWM | The high water mark of protected threads. |
+------------------+--------------------------------------------------+
| Use | The number of tasks using entry. |
+------------------+--------------------------------------------------+
| UseHWM | The high water mark of tasks using entry. |
+------------------+--------------------------------------------------+
| ReadyQ | The number of tasks on ready queue. |
+------------------+--------------------------------------------------+
| ReadyQHWM | The high water mark of tasks on ready queue. |
+------------------+--------------------------------------------------+
| Tasks | The number of tasks count. |
+------------------+--------------------------------------------------+
| Calls | The number of calls count. |
+------------------+--------------------------------------------------+
| Auths | The number of authorizations count. |
+------------------+--------------------------------------------------+
| Commits | The number of commits count. |
+------------------+--------------------------------------------------+
| Aborts | The number of aborts count. |
+------------------+--------------------------------------------------+
| Single | The number of R/O commits and single up. |
+------------------+--------------------------------------------------+
| ReUses | The number of thread reuses. |
+------------------+--------------------------------------------------+
| Terms | The number of thread terminates. |
+------------------+--------------------------------------------------+
| Overflow | The number of waits/overflow. |
+------------------+--------------------------------------------------+
| Waiters | The count of waiters. |
+------------------+--------------------------------------------------+
| Address | The address of the DB2ENTRY control block. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CDB2TRAN

CDB2TRAN Command

The CDB2TRAN command displays DB2TRAN resource definitions.


The DB2TRAN entry is associated with a DB2ENTRY definition.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
|CDB2Tran | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Name,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Name | Name of DB2TRAN definition |
+------------------+--------------------------------------------------+
| Tran | Transaction ID |
+------------------+--------------------------------------------------+
| DB2Entry | DB2ENTRY name |
+------------------+--------------------------------------------------+
| Plan | The plan name (if specified). |
+------------------+--------------------------------------------------+
| PlanExit | The plan exit name (if specified). |
+------------------+--------------------------------------------------+
| DefGroup | The name of the definition group from where |
| | the entry was installed. |
+------------------+--------------------------------------------------+
| DFHD2TRN | Address of the DFHD2TRN control block. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands
+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CDFHCNV

CDFHCNV Command

The CDFHCNV command displays the contents of the CICS DFHCNV


conversion table.

The sequence of the resource definitions is important. You should


put the most specific resource names at the top of the conversion
table and the least specific at the bottom.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CDFHCNV | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,SeqNo,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Type | The conversion table definition type. |
| | |
| | Possible values are: |
| | INITIAL |
| | ENTRY |
| | KEY |
| | SELECT |
| | FIELD |
| | |
| | The value is indented to show the structure |
| | within the definition entry. The "DefType" |
| | contains the same value with no indenting. |
+------------------+--------------------------------------------------+
| RType | The resource type. |
| | |
| | Possible values are: |
| | FC - File Control |
| | IC - Interval Control |
| | PC - Program Control |
| | TD - Transient Data |
| | TS - Temporary Storage |
+------------------+--------------------------------------------------+
| RName | The resource name. |
| | |
| | If the resource is defined as a prefix, |
| | the resource name value will contain "*" |
| | as the last character. |
+------------------+--------------------------------------------------+
| Option | The select options. |
| | |
| | Possible values are: |
| | DEFAULT |
| | COMPARE |
+------------------+--------------------------------------------------+
| Offset | The decimal offset to data. |
+------------------+--------------------------------------------------+
| DataLen | The decimal length of data. |
+------------------+--------------------------------------------------+
| DataType | The data type. |
| | |
| | Possible values are: |
| | BINARY |
| | CHARACTER |
| | DBCS |
| | MIXED |
| | NUMERIC |
| | PACKDECIMAL |
| | USERnnn |
+------------------+--------------------------------------------------+
| ClientCP | The client code page. |
| | |
| | For possible code page values see the CICS |
| | macro: DFHCNVS |
+------------------+--------------------------------------------------+
| ServerCP | The server code page. |
| | |
| | For possible code page values see the CICS |
| | macro: DFHCNVS |
+------------------+--------------------------------------------------+
| UsrExit | The user exit program name. |
+------------------+--------------------------------------------------+
| Data | The data value to be compared. |
+------------------+--------------------------------------------------+
| DefType | The conversion table definition type. |
| | |
| | Possible values are: |
| | INITIAL |
| | ENTRY |
| | KEY |
| | SELECT |
| | FIELD |
+------------------+--------------------------------------------------+
| SeqNo | The definition sequence number. |
+------------------+--------------------------------------------------+
| RPfx | Indicates the resource name is defined as a |
| | prefix. |
+------------------+--------------------------------------------------+
| XData | Indicates the value in the Data field is defined |
| | in hexadecimal. |
| | |
| | XData values are not converted to EBCDIC prior |
| | to comparison. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CDIR

CDIR Command

The CDIR command displays elements that have been defined to the
CICS Directory Domain.

Command Syntax

+------------------+--------------------------------------------------+
| CDIR | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Dir | The name of the directory. |
+------------------+--------------------------------------------------+
| Address | The address of the directory of element entry. |
+------------------+--------------------------------------------------+
| HNum | The hash number. |
+------------------+--------------------------------------------------+
| Hash | The address of the starting hash element slot. |
+------------------+--------------------------------------------------+
| Token1 | The token value. Bytes 1 - 4. |
+------------------+--------------------------------------------------+
| Token2 | The token value. Bytes 5 - 8. |
+------------------+--------------------------------------------------+
| KeyL | The key length of the element name. |
+------------------+--------------------------------------------------+
| Element | The name of the element defined to the directory |
| | domain. |
+------------------+--------------------------------------------------+

Line Commands
The following table lists the line commands defined by the
&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Select | Dump select control based on address field. |
| DUMp | |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CDISP

CDISP Command

The CDISP command displays statistics about the CICS dispatcher.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CDISP | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Tasks | The current number of CICS dispatcher tasks. |
+------------------+--------------------------------------------------+
| TaskHWM | The high water mark of CICS dispatcher tasks. |
+------------------+--------------------------------------------------+
| TCBsAtt | The current number of TCBs attached. |
+------------------+--------------------------------------------------+
| TCBsUsed | The number of CICS TCBs in use. |
+------------------+--------------------------------------------------+
| ICV | The ICV time value. |
+------------------+--------------------------------------------------+
| ICVR | The current task runaway time interval. |
+------------------+--------------------------------------------------+
| ICVTSD | The ICVTSD time value. |
+------------------+--------------------------------------------------+
| PRTYAGE | The current task priority aging factor. |
+------------------+--------------------------------------------------+
| MROBTCH | The number of events that must occur before |
| | CICS is posted for dispatch due to the |
| | batching mechanism. |
+------------------+--------------------------------------------------+
| SUBTSKS | The number of TCBs that CICS can use for |
| | running tasks in concurrent mode. |
+------------------+--------------------------------------------------+
| TCBModes | The number of CICS TCB modes. |
+------------------+--------------------------------------------------+
| TCBPools | The number of CICS TCB pools. |
+------------------+--------------------------------------------------+
| TCBScans | The number of excess TCB scans. |
+------------------+--------------------------------------------------+
| NoDetach | The number of excess TCB scans performed by the |
| | CICS dispatcher for which no CICS TCBs were |
| | detached. |
+------------------+--------------------------------------------------+
| Detached | The number of CICS TCBs that were detached by |
| | the CICS dispatcher during excess TCB scans. |
+------------------+--------------------------------------------------+
| AvgDet | The average number of CICS TCBs that were |
| | detached by the CICS dispatcher each scan. |
+------------------+--------------------------------------------------+
| DFHDSANC | The address of the DFHDSANC control block |
+------------------+--------------------------------------------------+
| DFHDSGDS | The address of the DFHDSGDS control block |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CDOCTEMP

CDOCTEMP Command

The CDOCTEMP command displays information about currently installed


document handler templates.

Command Syntax

+------------------+--------------------------------------------------+
| CDOCTEMP | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Document | The name of the document template |
+------------------+--------------------------------------------------+
| Type | The document template type. |
| | Valid values are: |
| | EXITPGM |
| | FILE |
| | MEMBER |
| | PROGRAM |
| | TDQUEUE |
| | TSQUEUE |
+------------------+--------------------------------------------------+
| Append | Specifies if CICS is to delete trailing blanks |
| | and append carriage control and line feed to |
| | each logical record in the template. |
+------------------+--------------------------------------------------+
| CharSet | The template character set. |
| | Valid values are: |
| | BINARY - when the template is loaded, no |
| | parsing of the template's contents |
| | is done. |
| | EBCDIC - when the template is loaded, the |
| | template's contents is parsed as |
| | EBCDIC text. |
+------------------+--------------------------------------------------+
| Body | The body of the template. This is the value |
| | associated with the template type. |
+------------------+--------------------------------------------------+
| Name | The full document template name. |
+------------------+--------------------------------------------------+
| DFHDHTLC | The address of the DFHDHTLC control block. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CDOMAINS

CDOMAINS Command

The CDOMAINS command displays information about CICS domains.

Command Syntax

+------------------+--------------------------------------------------+
| CDOMAINS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Name | The name of the domain. |
+------------------+--------------------------------------------------+
| Num | The number assigned to the domain by CICS. |
+------------------+--------------------------------------------------+
| Index | The domain index number. |
+------------------+--------------------------------------------------+
| Anchor | The address of the domain anchor block. |
+------------------+--------------------------------------------------+
| Header | The address of the domain header block. |
+------------------+--------------------------------------------------+
| Description | A description of the domain. |
+------------------+--------------------------------------------------+
| Active | Specifies if the domain is active. |
+------------------+--------------------------------------------------+
| Phase | Specifies the actual phase in domain. |
| | Common phase codes: |
| | 0A00 - Domain has initialized |
| | 0100 - Domain has quiesced |
| | |
| | Additional information can be found in the |
| | CICS Supplementary Data Areas manual. |
+------------------+--------------------------------------------------+
| Queue | Specifies the total time in queue. |
+------------------+--------------------------------------------------+
| StartD | Specifies the date and time when domain |
| StartT | initialization started. |
+------------------+--------------------------------------------------+
| InitD | Specifies the date and time when domain |
| InitT | initialization completed. |
+------------------+--------------------------------------------------+
| QStartD | Specifies the date and time when domain |
| QStartT | started to quiesce. |
+------------------+--------------------------------------------------+
| QuiesceD | Specifies the date and time when domain |
| QuiesceT | quiesce completed. |
+------------------+--------------------------------------------------+
| Standard | Specifies the STANDARD trace flags. |
+------------------+--------------------------------------------------+
| Special | Specifies the SPECIAL trace flags. |
+------------------+--------------------------------------------------+
| AffTCB | Specifies the affinity to a specific CICS |
| | TCB if any. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Gates | Invokes the CGATES command for the selected |
| | domain. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CDSAS

CDSAS Command

The CDSAS command displays information about each Dynamic Storage


Area defined by CICS.

Command Syntax

+------------------+--------------------------------------------------+
| CDSAS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Storage | The CICS storage protection option. |
| protection | Possible values are: |
| | |
| | ACTIVE |
| | INACTIVE |
+------------------+--------------------------------------------------+
| IEP | Indicates whether Instruction Execution |
| | Protection is supported. |
| | Possible values are: |
| | |
| | ACTIVE |
| | INACTIVE |
+------------------+--------------------------------------------------+

DSA and Private Storage Statistics


+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Region | The name of the Dynamic Storage Area (DSA) or |
| | private storage region name. |
+------------------+--------------------------------------------------+
| User | The current amount of user storage allocated |
| | (PVT and E-PVT only). |
+------------------+--------------------------------------------------+
| Sys | The current amount of system storage allocated |
| | (PVT and E-PVT only). |
+------------------+--------------------------------------------------+
| Alloc | The current amount of total storage allocated. |
+------------------+--------------------------------------------------+
| Free | The amount of free storage available. |
| | |
| | Free = Size - Alloc (DSA and EDSA) |
| | Free = Limit - User (PVT and E-PVT) |
+------------------+--------------------------------------------------+
| PctS | The percent of storage size allocated. |
| | |
| | PctS = Alloc / Size |
+------------------+--------------------------------------------------+
| Size | The current size of the DSA or private storage |
| | region. |
+------------------+--------------------------------------------------+
| PctL | The percent of storage limit allocated. |
| | |
| | PctL = Alloc / Limit (DSA and EDSA) |
| | PctL = User / Limit (PVT and E-PVT) |
+------------------+--------------------------------------------------+
| Limit | The storage limit size. |
| | |
| | For DSA storage: |
| | Maximum total size of DSA (DSA and EDSA) |
| | |
| | The limit values for DSA and EDSA can be altered.|
| | |
| | The DSA "Limit" field is highlighted when |
| | insufficient private storage is available for |
| | the DSA to reach its defined limit. |
| | |
| | If color terminal attributes are supported, the |
| | DSA and EDSA limit value will be displayed based |
| | on the screen attribute definitions for INPUT |
| | and INPUTHI found on the SCREEN command. |
| | |
| | For private storage: |
| | Private storage limit (PVT and EPVT) |
| | |
| | The current amount of storage available for |
| | allocation to the User region in private. This |
| | is a dynamic value based on the amount of system |
| | storage (Sys) allocated or the region limit, |
| | whichever is smaller. |
| | |
| | The limit value for E-PVT can be altered from |
| | the PRIVATE display. |
+------------------+--------------------------------------------------+
| Avail | The amount of additional private storage that is |
| | currently available to DSA extent allocation. |
| | This value may be larger than the actual limit |
| | defined to the set of DSAs. If the available |
| | storage value is greater, then it is possible |
| | that storage is not being fully used. |
+------------------+--------------------------------------------------+
| High | The high water mark of storage allocation. |
+------------------+--------------------------------------------------+
| SOS | Specifies whether the DSA is Short-On-Storage |
| | (SOS). |
+------------------+--------------------------------------------------+
Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DSAname | The name of the Dynamic Storage Area (DSA). |
| | |
| | Two additional lines will be displayed to |
| | show the unused or free DSA extents that are |
| | currently allocated. The DSAname will be |
| | displayed as "FreeDSA" and "FreeEDSA". |
+------------------+--------------------------------------------------+
| Size | The current size of the DSA that is allocated. |
+------------------+--------------------------------------------------+
| Alloc | The total amount of allocated storage within the |
| | DSA. |
+------------------+--------------------------------------------------+
| Free | The total amount of free storage available |
| | within the DSA. |
+------------------+--------------------------------------------------+
| MFree | The maximum block of free contiguous storage |
| | that is available. |
+------------------+--------------------------------------------------+
| SOS | Specifies whether the DSA is Short-On-Storage |
| | (SOS). CICS sets an SOS condition if one of the |
| | following occurs: |
| | |
| | * After a successful GETMAIN, the number of |
| | unallocated DSA pages is less than the |
| | cushion size |
| | |
| | * CICS cannot satisfy an unconditional GETMAIN |
| | because there is no contiguous area large |
| | enough |
+------------------+--------------------------------------------------+
| Queued | The number of storage requests that are |
| | currently queued for the DSA. |
+------------------+--------------------------------------------------+
| Used | The percentage of storage allocated within the |
| | DSA. |
| | |
| | Used = (Alloc * 100) / Size |
+------------------+--------------------------------------------------+
| LPct | The percentage of DSA limit allocated. |
| | |
| | LPct = (Alloc * 100) / Limit |
+------------------+--------------------------------------------------+
| Limit | The current possible limit for DSA. This is the |
| | maximum size that the DSA could become based on |
| | available private storage and the CICS defined |
| | DSA limit. |
+------------------+--------------------------------------------------+
| Avail | The available private storage that could be |
| | allocated to additional DSA extents. It is |
| | possible for there to be more storage available |
| | for allocation than can be used due to CICS |
| | defined DSA limits. |
+------------------+--------------------------------------------------+
| Access | The access type of the DSA. |
| | Possible values are: |
| | |
| | blank |
| | CICS |
| | USER |
| | READ |
| | TRUST |
| | SECURE |
+------------------+--------------------------------------------------+
| IEP | Indicates whether Instruction Execution |
| | Protection is supported. |
+------------------+--------------------------------------------------+
| Extents | The number of DSA extents in use. |
+------------------+--------------------------------------------------+
| StgV | The number of storage violations that have |
| | occurred within the DSA. CICS detects storage |
| | violations when either of the following has |
| | become corrupted: |
| | |
| | * The duplicate storage accounting area (SAA) |
| | or the initial SAA of the TIOA storage |
| | element |
| | |
| | * The leading storage check zone or the |
| | trailing storage check zone of a user-task |
| | storage element |
+------------------+--------------------------------------------------+
| HWM-Size | The maximum size (high water mark) of the DSA. |
+------------------+--------------------------------------------------+
| Cushion | The storage cushion size available within the |
| | DSA. |
| | |
| | Because cushion storage is used for |
| | Short-On-Storage conditions, a large amount |
| | wastes virtual storage in the DSA that could be |
| | available for normal processing. Not enough |
| | cushion storage may prohibit tasks from being |
| | purged, and cause unrecoverable stress. |
| | |
| | NOTE: Storage cushions should not be below |
| | 64 KB. |
+------------------+--------------------------------------------------+
| Page | The size of each DSA page, in bytes. |
+------------------+--------------------------------------------------+
| Primary | The primary allocation size of the DSA. |
+------------------+--------------------------------------------------+
| Align | The DSA extent alignment boundary. |
+------------------+--------------------------------------------------+
| Fix | Indicates that the DSA is a fixed size. |
+------------------+--------------------------------------------------+
| LowFree | The low water mark of available storage. |
+------------------+--------------------------------------------------+
| Hi-Queue | The maximum (high water mark) number of storage |
| | requests that have been queued at any one time. |
+------------------+--------------------------------------------------+
| Suspends | The number of requests that had to be suspended |
| | to satisfy the storage request. |
+------------------+--------------------------------------------------+
| SOS-Cnt | The number of times that the DSA has gone |
| | Short-On-Storage. |
+------------------+--------------------------------------------------+
| SOS-Time | The total time spent Short-On-Storage. |
+------------------+--------------------------------------------------+
| LastDate | The date of the last Short-On-Storage condition. |
+------------------+--------------------------------------------------+
| LastTime | The time of the last Short-On-Storage condition. |
+------------------+--------------------------------------------------+
| PPA | Address of the PPA control block. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Elements | Invokes the CELEMENT command to display a list |
| | of allocated storage blocks. |
+------------------+--------------------------------------------------+
| PAM | Invokes the CDSAX DETAIL command to display the |
| | Dynamic Storage Area Extents and Page Allocation |
| | Maps. |
+------------------+--------------------------------------------------+
| Plot | Invokes the PLOT command to display the DSA |
| | percent used of the Limit. |
+------------------+--------------------------------------------------+
| PRograms | Invokes the CPROGRAM command to display a list |
| | of programs loaded in the selected DSA. |
+------------------+--------------------------------------------------+
| Subpools | Invokes the CSUBPOOL command to display a list |
| | of allocated subpools. |
+------------------+--------------------------------------------------+
| Xtents | Invokes the CDSAX command to display the |
| | Dynamic Storage Area Extents. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CDSAX

CDSAX Command

The CDSAX command displays information about each Dynamic Storage


Area extent created by CICS. The page allocation map of the extent
is displayed in the DETAIL view.

Command Syntax

+------------------+--------------------------------------------------+
| CDSAX | [ Summary | Detail ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| SUMMARY | Display summary view |
+------------------+--------------------------------------------------+
| DETAIL | Specifies that the detailed view should be |
| | displayed. The detail view displays the page |
| | allocation map associated with each DSA extent. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DSAname | The name of the Dynamic Storage Area (DSA). |
| | Free DSA extents will be displayed as "FreeDSA" |
| | and "FreeEDSA". |
+------------------+--------------------------------------------------+
| Size | The size, in bytes, of the DSA extent. |
+------------------+--------------------------------------------------+
| Free | The amount of free storage within the DSA |
| | extent. |
+------------------+--------------------------------------------------+
| MFree | The maximum block of free contiguous storage |
| | that is available. |
+------------------+--------------------------------------------------+
| Used | The percentage of the DSA extent that is in use. |
+------------------+--------------------------------------------------+
| Start | The starting address of the extent. |
| | |
| | Summary view: |
| | Starting address of the DSA extent |
| | |
| | Detail view: |
| | Starting address of the DSA extent with |
| | regards to the PageAllocationMap |
+------------------+--------------------------------------------------+
| End | The ending address of the extent. |
| | |
| | Summary view: |
| | Ending address of the DSA extent |
| | |
| | Detail view: |
| | Ending address of the DSA extent with regards |
| | to the PageAllocationMap |
+------------------+--------------------------------------------------+
| PageSize | The size of each page within the extent. |
+------------------+--------------------------------------------------+
| Pages | The number of pages. |
+------------------+--------------------------------------------------+
| PPX | The address of the Page Pool Extent control |
| | block. |
+------------------+--------------------------------------------------+
| PPA | Specifies the address of the PPA control block. |
+------------------+--------------------------------------------------+
| Map | The address of the page allocation map. |
| | If the entry is for a free DSA extent, the |
| | address will be the address of the extent. |
+------------------+--------------------------------------------------+
| PAM | The DSA page allocation map. |
| | |
| | Summary view: |
| | This field displays "n/r" |
| | |
| | Detail view: |
| | This field maps the individual pages within |
| | each DSA. If the page is allocated, then: |
| | |
| | Allocated pages = "@" |
| | Unallocated pages = "." |
| | |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Elements | Invokes the CELEMENT command to display a list |
| | of allocated storage blocks. |
+------------------+--------------------------------------------------+
| Plot | Invokes the PLOT command to display the DSA |
| | percentage full. |
| | |
| | CDSA, UDSA, SDSA, and RDSA are specific areas of |
| | the DSA. |
| | |
| | ECDSA, EUDSA, ESDSA, and ERDSA are specific |
| | areas of the EDSA. |
| | |
| | The eight DSAs defined to CICS do not have a |
| | static size. Therefore, when plotting a DSA, |
| | the overall DSA is used. |
+------------------+--------------------------------------------------+
| Subpools | Invokes the CSUBPOOL command to display a list |
| | of allocated subpools. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CDUMPMGT

CDUMPMGT Command

The CDUMPMGT command displays a list of SYSVIEW dump management


definitions and statistics since the start of the SYSVIEW for
CICS data collector.

Definitions can be added or maintained here (warm start) or


in parmlib member CICSDMPM (cold start).

The Dump Management function can be used to enhance the CICS-provided


function to suppress unwanted dumps.

The built-in function provided by CICS only allows dumps to be


suppressed based on the dump code. The SYSVIEW dump management
definitions allow a dump to be taken or suppressed based on any
or all of the following:

* Transaction ID
* Program name
* Dump code

Command Syntax

+------------------+--------------------------------------------------+
| CDUMPMGT | [ REGion | SYStem ] |
| | [ Local | Global ] |
| | |
| | [ GROUP name ] |
| | [ SAVE ] |
| | [ ADD tranid [ program |
| | dumpcode |
| | trandump |
| | sysdump |
| | abendnotify |
| | dumpnotify ] |
| | [ DELETE tranid program dumpcode ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| Local | |
+------------------+--------------------------------------------------+
| SYStem | Display all CICS address spaces currently being |
| Global | monitored on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| SAVE | Save the definitions to the persistent data |
| | store. |
| | |
| | If mode = REGION, the definitions for the |
| | current CICS jobname will be saved. |
| | |
| | If mode = SYSTEM, the definitions for all CICS |
| | jobnames on the current system will be saved. |
+------------------+--------------------------------------------------+
| ADD | Add new definition. |
| | |
| | Parameters: |
| | |
| | tranid - transaction ID |
| | |
| | program - program name |
| | |
| | dumpcode - dump or abend code |
| | |
| | trandump - Specifies if a transaction dump |
| | is requested, should the dump |
| | be taken or suppressed. |
| | |
| | Valid values are: |
| | YES - allow dump to be taken |
| | NO - suppress dump |
| | |
| | sysdump - Specifies if a system dump |
| | is requested, should the dump |
| | be taken or suppressed. |
| | |
| | Valid values are: |
| | YES - allow dump to be taken |
| | NO - suppress dump |
| | |
| | abend - Specifies if a message is to be |
| | notify written to the joblog whenever a |
| | CICS transaction abends. |
| | |
| | Valid values are: |
| | * |
| | NONE |
| | SHORT |
| | LONG |
| | |
| | dump - Specifies if a message is to be |
| | notify written to the joblog whenever a |
| | CICS dump is taken. |
| | |
| | Valid values are: |
| | * |
| | YES |
| | NO |
| | |
+------------------+--------------------------------------------------+
| DELETE | Delete definition. |
| | |
| | Parameters: |
| | |
| | tranid - transaction ID |
| | program - program name |
| | dumpcode - dump or abend code |
| | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+
| StartMode | Specifies the start mode at product |
| | initialization for the definitions. |
| | |
| | Possible values are: |
| | |
| | COLD - Definitions were obtained |
| | from parmlib members. |
| | |
| | WARM - Definitions were obtained |
| | from the persistent data store. |
| | If the data was not available in |
| | the persistent data store, the |
| | data will then be obtained from |
| | parmlib members. |
| | |
| | This value is initially set in parmlib member |
| | SVWCOPTS option DUMP-MANAGEMENT-STARTTYPE |
| | but can be overridden at SYSVIEW startup. |
+------------------+--------------------------------------------------+
| Checkpoint | Indicates whether a checkpoint is needed to save |
| | modified definitions. |
| | |
| | Possible values are: |
| | |
| | SAVED - No checkpoint is needed. |
| | |
| | REQUIRED - Definitions have been changed. |
| | These changes have not been |
| | saved. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Tranid | The transaction ID. |
+------------------+--------------------------------------------------+
| Program | The application program name. |
+------------------+--------------------------------------------------+
| Dumpcode | The abend dump code. |
+------------------+--------------------------------------------------+
| Dumps | The number of dump requests processed. |
+------------------+--------------------------------------------------+
| Tran | When a transaction dump is requested, specify |
| | whether the dump request should be allowed to |
| | continue or whether the dump request should |
| | be suppressed. |
| | |
| | Valid values are: |
| | |
| | YES - Allow the dump request to continue. |
| | The dump is NOT suppressed. |
| | |
| | NO - Suppress the dump. |
| | |
| | This value can be modified. |
+------------------+--------------------------------------------------+
| TranDump | The number of transaction dump requests that |
| | were allowed to continue. Suppression was not |
| | requested. |
+------------------+--------------------------------------------------+
| TranSupp | The number of transaction dump requests that |
| | were suppressed. |
+------------------+--------------------------------------------------+
| Sys | When a system dump is requested, specify |
| | whether the dump request should be allowed to |
| | continue or whether the dump request should |
| | be suppressed. |
| | |
| | Valid values are: |
| | |
| | YES - Allow the dump request to continue. |
| | The dump is NOT suppressed. |
| | |
| | NO - Suppress the dump. |
| | |
| | This value can be modified. |
+------------------+--------------------------------------------------+
| SysDump | The number of system dump requests that |
| | were allowed to continue. Suppression was not |
| | requested. |
+------------------+--------------------------------------------------+
| SysSupp | The number of system dump requests that |
| | were suppressed. |
+------------------+--------------------------------------------------+
| AbNotify | Specifies if a message is to be written to the |
| | joblog whenever a CICS transaction abends. |
| | |
| | If an abend occurs, an attempt will be made to |
| | match the abending transaction to an entry in |
| | this table. If a match is found, the AbNotify |
| | method will be used to determine if and how |
| | messages are to be written. If a match is not |
| | found, the default specified by the |
| | ABEND-NOTIFICATION configuration option in the |
| | SVWCOPTS parmlib member is used. |
| | |
| | Valid values are: |
| | |
| | * - The notification type value will |
| | be set based on the configuration |
| | option "ABEND-NOTIFICATION" |
| | that is defined in the parmlib |
| | member SVWCOPTS. |
| | |
| | NONE - No message written |
| | |
| | SHORT - A single GSVC201E message will |
| | be written. Information included: |
| | |
| | Transaction ID |
| | Task number |
| | Abend code |
| | Program |
| | Request ID |
| | Resource |
| | |
| | LONG - A set of messages will be written. |
| | Information included: |
| | |
| | Transaction ID |
| | Task number |
| | Abend code |
| | Program |
| | Request ID |
| | Resource |
| | PSW |
| | Access registers |
| | General registers |
| | |
+------------------+--------------------------------------------------+
| DumpNotify | Specifies if a message is to be written to the |
| | joblog whenever a CICS dump is taken. |
| | |
| | If a dump occurs, an attempt will be made to |
| | match the dumping transaction to an entry in |
| | this table. If a match is found, the DumpNotify |
| | method will be used to determine if and how |
| | messages are to be written. If a match is not |
| | found, the default specified by the |
| | DUMP-NOTIFICATION configuration option in the |
| | SVWCOPTS parmlib member is used. |
| | |
| | Valid values are: |
| | |
| | * - The notification type value will |
| | be set based on the configuration |
| | option "DUMP-NOTIFICATION" |
| | that is defined in the parmlib |
| | member SVWCOPTS. |
| | |
| | NO - No message written |
| | |
| | YES - A GSVC118W message will be written. |
| | |
| | The dump type |
| | The dump code |
| | The dump ID |
| | The active transaction ID |
| | The active task number |
| | The active program |
| | The terminal ID |
| | The userid |
| | The abend code |
| | |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Add | Add a new dump management definition. This |
| | command must be used on the dummy input line. |
| | This line contains the value DUMMY in the Dumps |
| | field. |
+------------------+--------------------------------------------------+
| DELete | Delete the selected definition. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| ADD | Add new definition. |
| | |
| | Syntax: |
| | |
| | ADD tranid [ program dumpcode ] |
| | |
| | Parameters: |
| | |
| | tranid - transaction ID |
| | program - program name |
| | dumpcode - dump or abend code |
| | |
+------------------+--------------------------------------------------+
| SAVE | Save the definitions to the persistent data |
| | store. |
| | |
| | If mode = LOCAL, the definitions for the |
| | current CICS jobname will be saved. |
| | |
| | If mode = GLOBAL, the definitions for all CICS |
| | jobnames on the current system will be saved. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CDUMPMGT command security


CDUMPS

CDUMPS Command

The CDUMPS command displays a list of CICS dump definitions and


statistics since the last CICS statistics reset.

Command Syntax

+------------------+--------------------------------------------------+
| CDUMPS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Dump Dataset | The ddname of the current dump data set. |
+------------------+--------------------------------------------------+
| Transaction Dumps| The total number of transaction dumps taken. |
+------------------+--------------------------------------------------+
| Suppressed | The total number of transaction dumps |
| | suppressed. |
+------------------+--------------------------------------------------+
| In Progress | Specifies that a transaction dump is in progress.|
+------------------+--------------------------------------------------+
| System Dumps | The total number of system dumps taken. |
+------------------+--------------------------------------------------+
| Suppressed | The total number of system dumps suppressed. |
+------------------+--------------------------------------------------+
| In Progress | Specifies that a system dump is in progress. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Name | The abend dump code. |
+------------------+--------------------------------------------------+
| Dumps | The number of dump calls since CICS startup. |
+------------------+--------------------------------------------------+
| Max | The maximum number of dumps to be taken. |
+------------------+--------------------------------------------------+
| Shut | Specifies that CICS is to be shutdown after the |
| | dump is taken. |
+------------------+--------------------------------------------------+
| Tran | Specifies that a transaction dump is to be |
| | taken. |
+------------------+--------------------------------------------------+
| TranDump | The number of transaction dumps taken. |
+------------------+--------------------------------------------------+
| TranSupp | The number of transaction dumps suppressed. |
+------------------+--------------------------------------------------+
| Sys | Specifies that a system dump is to be taken. |
+------------------+--------------------------------------------------+
| SysDump | The number of system dumps taken. |
+------------------+--------------------------------------------------+
| SysSupp | The number of system dumps suppressed. |
+------------------+--------------------------------------------------+
| Scope | The scope of the dump. Valid values are LOCAL |
| | or RELATED. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CEDA

CEDA Command

The CEDA command provides easy method of executing a CICS CEDA


function.

Command Syntax

+------------------+--------------------------------------------------+
| CEDA | [ceda_command_arguments] |
+------------------+--------------------------------------------------+

Parameters

All responses from the CEDA function are logged to the ddname GSVCLOG
file for the corresponding CICS address space.

Related Information

The CCEDA command can be used to display the responses from a


CEDA request. The CCEDA command is SYSTEM and XSYSTEM capable.

Security Requirements

CEDA requests execute under the user context assigned to the


GSVI transaction executing in the CICS address space.

Assign a userid to the GSVI CICS transaction


CEITLOG

CEITLOG Command

The CEITLOG command displays CICS transaction records that have


been monitored or traced based on an EXEC Interface trace definition.
Trace definitions are displayed by the CEITRACE command.

In addition to a matching trace definition, the following CICS


configuration options must be set on the CCONFIG command for CICS
transaction detail records to be displayed by CEITLOG:

TRANSACTION-DATA-EXECCICS CEITRACE
TRANSACTION-RECORD-EXECCICS YES

If the following values are specified then all transaction records will
contain summary EXEC Interface trace information. The records can be
displayed by the CTRANLOG command, but will not be duplexed to CEITLOG.

TRANSACTION-DATA-EXECCICS YES
TRANSACTION-RECORD-EXECCICS YES

A log can potentially contain a very large number of records. For


this reason, only the specified number of records will be displayed.
This set of records is referred to as the "display window", and is
controlled by the LINES parameter on the command or the LINES
parameter on the OPTIONS subcommand.

Command Syntax

+------------------+--------------------------------------------------+
| | |
| &HelpMember | [ STREAM logstream ] |
| | |
| | [ DATE * | date ] |
| | [ TIME * | time ] |
| | |
| | [ READNext ] |
| | [ READPrev ] |
| | |
| | [ PERiod hh:mm:ss ] |
| | [ CUSHion hh:mm:ss ] |
| | |
| | [ LINEs datalines ] |
| | [ LIMit readlimit ] |
| | [ ELAPsedlimit hh:mm:ss ] |
| | |
| | [ RECtime END | START ] |
| | |
| | [ DISCARD ] |
| | [ NODISCARD ] |
| | |
| | [ FILTER ] |
| | [ NOFILTER ] |
| | |
| | [ GROUP group ] |
| | [ JOBName jobname ] |
| | [ TRAN tran ] |
| | [ TERMinal terminal ] |
| | [ USERid userid ] |
| | [ PROGRAM program ] |
| | [ ABND abendcode ] |
| | [ EITRACE name ] |
| | |
| | [ LIFETIME oper time ] |
| | [ CPUTIME oper time ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| STREAM logstream | Specifies the log stream name from which to |
| | display data. |
| | |
| | If no log stream name is specified, the parmlib |
| | member LGLOOKUP will be used to locate a |
| | matching log stream name. |
| | |
| | Use the following "short" names to substitute |
| | the default log stream name for the indicated |
| | record type: |
| | |
| | AUDIT - Audit events |
| | CICSEITL - CICS EXEC interface trace log |
| | CICSSYSD - CICS system interval analysis |
| | CICSTRAN - CICS transaction log |
| | CICSTSUM - CICS transaction summary log |
| | CICSXLOG - CICS exception log |
| | CTGLOG - CICS Transaction Gateway log |
| | IMSIMTR - IMS transaction log |
| | IMSIMRS - IMS region summary log |
| | IMSIMTS - IMS transaction summary log |
| | IMSOMAT - IMS OM audit trail log |
| | MQSDATA - MQ request history log |
| | OPERLOG - Operations log stream |
| | PLOTLOG - Historical plot log |
| | SMFDATA - SMF log |
| | XLOG - Exception log |
| | ZCNRLOG - z/OS Connect request log |
| | |
+------------------+--------------------------------------------------+
| DATE date | Position to specified date in log. |
| | Read records from the starting point in a |
| | forward direction ( youngest to newest ). |
| | |
| | date - The date value must be specified |
| | using the date format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | Query current date format |
| | |
| | * - Use the current date (today). |
| | |
| | -days - Position to today's date |
| | minus the specified number |
| | of days. |
| | |
| | If a DATE value is supplied and a TIME |
| | value is not supplied, the current TIME (now) |
| | will be used. |
| | |
+------------------+--------------------------------------------------+
| TIME time | Position to specified time in log. |
| | |
| | time - The time value must be specified |
| | using the time format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | Query current time format |
| | |
| | * - Use the current time (now). |
| | |
| | nnAM - The time value can also be |
| | nnPM specified using one of the |
| | following values: |
| | 12AM | 1AM | 2AM | ... | 11AM |
| | 12PM | 1PM | 2PM | ... | 11PM |
| | NOON | MIDNIGHT |
| | |
| | -adjust - Set the time value to the |
| | +adjust current time (now) plus or minus |
| | the specified adjustment value. |
| | |
| | Example adjustment values: |
| | |
| | -0.500000 - 0.5 seconds |
| | -60 - 60 seconds |
| | -120Sec - 120 seconds |
| | -5MINutes - 5 minutes |
| | -1Hours - 1 hour |
| | -1Days - 1 day |
| | -hh:mm:ss - hours:minutes:seconds |
| | |
| | +0.500000 + 0.5 seconds |
| | +60 + 60 seconds |
| | +120Sec + 120 seconds |
| | +5MINutes + 5 minutes |
| | +1Hours + 1 hour |
| | +1Days + 1 day |
| | +hh:mm:ss + hours:minutes:seconds |
| | |
| | If a TIME value is supplied and a DATE |
| | value is not supplied, the current DATE |
| | will be used. |
| | |
+------------------+--------------------------------------------------+
| READPrev | If a date or time value is specified, READPREV |
| | specifies that the log is to be read starting |
| | at the date and time and read backwards |
| | (youngest to oldest). |
| | |
| | If date or time is not specified, the READPREV |
| | parameter is ignored. |
| | |
+------------------+--------------------------------------------------+
| READNext | If a date or time value is specified, READNEXT |
| | specifies that the log is to be read starting |
| | at the date and time and read forwards |
| | (oldest to youngest). |
| | |
| | If date or time is not specified, the READNEXT |
| | parameter is ignored. |
| | |
+------------------+--------------------------------------------------+
| PERiod hh:mm:ss | Specifies the time period for which records are |
| | to be displayed. |
| | |
| | Default : 0 (unlimited) |
| | |
| | Example values: |
| | |
| | NONE - No period (unlimited) |
| | 0 - No period (unlimited) |
| | 0.500000 - 0.5 seconds |
| | 60 - 60 seconds |
| | 120Sec - 120 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | 1Days - 1 day |
| | 1MONths - 1 month |
| | 1Years - 1 year |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| CUSHion hh:mm:ss | Specifies the time period cushion for which |
| | records are to be read for display. |
| | |
| | Data records stored in an MVS log stream are |
| | sequenced or sorted based on the actual time |
| | the record was written to the stream. |
| | |
| | This does not guarantee that the records are |
| | sorted in a time sequence based on the |
| | date and time information that is potentially |
| | contained within each record. |
| | |
| | For this reason, when a user wants to display |
| | a specific time period of data, additional |
| | records must be read on the front and back |
| | end of the read process to ensure that the |
| | records that might be out of sequence are |
| | included. |
| | |
| | The time period cushion specifies the extra |
| | records to be read. |
| | |
| | Example Cushion: |
| | |
| | Start time: 8AM |
| | Period : 1 Hour |
| | Cushion : 5 minutes |
| | |
| | Read Begin : 07:55:00 |
| | -- Discard records |
| | Display Begin : 08:00:00 |
| | -- Display records |
| | Display End : 09:00:00 |
| | -- Discard records |
| | Read End : 09:05:00 |
| | |
| | Example values: |
| | |
| | NONE - No cushion |
| | 0 - No cushion |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| LINEs count | Specifies the maximum number of data rows to |
| | be displayed. |
| | |
| | Default : 25000 |
| | Minimum : 1 |
| | Maximum : 1000000 |
| | |
| | Specifying the LINES value with the primary |
| | command syntax does not alter or change the |
| | default value stored in the user profile. |
| | |
| | The default value can be altered using the |
| | subcommand: OPTIONS LINES count |
| | |
| | The actual number of data rows displayed may |
| | be greater than the specified LINES value if |
| | a record or message expanded to multiple lines. |
| | |
+------------------+--------------------------------------------------+
| LIMit count | Specifies the maximum number of records to be |
| | read. |
| | |
| | Specifying the LIMIT value with the primary |
| | command syntax does not alter or change the |
| | default value stored in the user profile. |
| | |
| | The default value can be altered using the |
| | subcommand: OPTIONS LIMIT count |
| | |
| | Default : 1000000 |
| | |
+------------------+--------------------------------------------------+
| ELAPsed hh:mm:ss | Specifies the elapsed time limit for reading |
| | or searching the log streams for desired |
| | data. |
| | |
| | If the log stream being searched is very large, |
| | the search time required can be substantial. |
| | This is especially true if a large number |
| | of data LINES has been requested and the |
| | number of data records that would satisfy |
| | the search request are spread across the |
| | entire log stream. |
| | |
| | The log browse search will be interrupted |
| | when the elapsed time limit is reached. |
| | |
| | The search can be continued using the |
| | subcommands: NEXT or PREVIOUS |
| | |
| | Example values: |
| | |
| | NONE - No timeout |
| | 0 - No timeout |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| RECORDTime | Specifies whether the "start" or "end" date |
| RECTime | and time should be used for the records. |
| | |
| | Not all records have a start and an end |
| | time. Records that do not have both a start |
| | and an end time are considered "events". |
| | |
| | Records that are interval based typically |
| | do have a start and end time. |
| | |
| | Records that are event based typically do not. |
| | |
| | Valid values: |
| | |
| | END |
| | START |
| | EVENT |
| | |
+------------------+--------------------------------------------------+
| DISCard | Specifies whether records found to be in the |
| NODISCard | time period cushion should be discarded or |
| | kept. |
| | |
| | DISCARD - Discard the records found in |
| | the cushion. (default) |
| | |
| | NODISCARD - Keep the records found in the |
| | cushion. |
| | |
+------------------+--------------------------------------------------+
| FILTER | Display a "filter" screen to allow the |
| NOFILTER | entering of command syntax parameters to |
| | filter the data. |
| | |
| | When the "FILTER" keyword is entered as part |
| | of the primary command, the parameters entered |
| | will be used to populate the filter display. |
| | |
| | After entering desired data on the filter |
| | display, the following function keys can |
| | be used: |
| | |
| | ENTER - Validate the data entered. |
| | No processing occurs. |
| | |
| | F1 - Invoke HELP for the filter display. |
| | |
| | F3 - Validate the data entered and |
| | process the data to build the |
| | display. |
| | |
| | F12 - Do not validate data. No processing |
| | occurs. The existing data is |
| | redisplayed. |
| | |
| | FILTER - Display filter. |
| | |
| | NOFILTER - Do not display filter (default). |
| | |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| GROUP | Specifies a logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames to be |
| | displayed. |
| | |
| | Syntax: GROUP group |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used as the |
| | default. |
| | |
| | The current profile setting can be viewed using |
| | the following: QUERY CICSGROUP |
| | |
| | The list of CICSPLEX groups can be found on |
| | GROUPS command. |
+------------------+--------------------------------------------------+
| JOBName | Specifies the jobname that is to be displayed. |
| | |
| | The jobname can be specified as: |
| | * Specific jobname |
| | * Generic jobname |
| | * Logical group name containing a list of |
| | of CICS jobnames. |
| | Logical group type = CICSPLEX |
| | Syntax: ]group |
| | |
| | Syntax: JOBNAME jobname |
+------------------+--------------------------------------------------+
| TRAN | Specifies the transaction that is to be |
| | displayed. The "Tran" and "OTran" fields will |
| | be examined for a match. |
| | Syntax: TRAN tran |
+------------------+--------------------------------------------------+
| TERMINAL | Specifies the terminal that is to be displayed. |
| | The "Term" and the "LUName" fields will be |
| | examined for a match. |
| | Syntax: TERMINAL terminal |
+------------------+--------------------------------------------------+
| USERID | Specifies the userid that is to be displayed. |
| | Syntax: USERID userid |
+------------------+--------------------------------------------------+
| PROGRAM | Specifies the program name that is to be |
| | displayed. |
| | Syntax: PROGRAM program |
+------------------+--------------------------------------------------+
| ABND | Specifies the abend code that is to be displayed.|
| | Syntax: ABND abnd |
+------------------+--------------------------------------------------+
| EITRACE | Specifies the name of the EXEC Interface |
| | trace definition that requested EXEC CICS |
| | interface requests to be monitored. |
| | Syntax: EITRACE name |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| LIFETIME | Display those transactions that match the |
| | select criteria for transaction lifetime. |
| | Syntax: LIFETIME oper time |
+------------------+--------------------------------------------------+
| CPUTIME | Display those transactions that match the |
| | select criteria for transaction CPU time. |
| | Syntax: CPUTIME oper time |
+------------------+--------------------------------------------------+
| oper | Selection operator. |
| | |
| | Valid values are: |
| | |
| | EQ, = |
| | LT, [ |
| | LE, [= |
| | GT, ] |
| | GE, ]= |
| | NE, ¬=, [] |
| | NG, ¬] |
| | NL, ¬[ |
| | |
+------------------+--------------------------------------------------+
| time | Time value in seconds. |
| | The value can be specified in the following |
| | formats: |
| | |
| | 0.000000 |
| | HH:MM:SS |
| | |
+------------------+--------------------------------------------------+

Information Fields

The Information Section area is cursor selectable.


If the cursor is in the Information Section and the [ENTER] key
is pressed, the "FILTER" panel will be displayed.

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| LogStream | The name of the log stream from which data |
| | is being displayed. |
| | |
| | The keyword "ASIS" will follow the log stream |
| | name if the records are being read ASIS. |
| | ASIS specifies that no record decompression |
| | has been requested. |
+------------------+--------------------------------------------------+
| Retention | The log stream retention period. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Available | The time and date of the first and last records |
| | in the physical log stream. |
| | |
| | Commands that display the contents of log |
| | streams will only display those records that |
| | are relevant to the specific command. The log |
| | stream may contain other records. |
| | |
| | The available time and date information may not |
| | reflect the actual usable data records if the |
| | log stream contains data different than what |
| | corresponds to the active command. |
+------------------+--------------------------------------------------+
| Searched | The searched range of records processed. |
+------------------+--------------------------------------------------+
| Displayed | The current "display window" of records being |
| | displayed. |
| | |
| | The time and date of the first and last records |
| | displayed. |
| | |
| | This value can be modified to position to a new |
| | starting time and date. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Lines | Specifies the maximum number of data rows |
| | to be displayed. |
+------------------+--------------------------------------------------+
| Limit | Specifies the maximum number of records to be |
| | read in order to satisfy the specified "Lines" |
| | value. |
| | The value "NONE" indicates that no limit or |
| | "0" was specified. |
+------------------+--------------------------------------------------+
| Period | Specifies the time period for which records are |
| | to be displayed. |
| | The value "NONE" indicates that no time period |
| | was specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: Date,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Date | The end date of the transaction. |
+------------------+--------------------------------------------------+
| Time | The end time of the transaction. |
+------------------+--------------------------------------------------+
| Tran | The name of the transaction. If the transaction |
| | name is followed by a "+", then the record has |
| | been truncated. If the transaction name starts |
| | with a "+", then the record is a continuation |
| | record from a previously truncated record. |
| | The transaction is highlighted if the entry |
| | contains an abend, exception, or threshold |
| | information. |
+------------------+--------------------------------------------------+
| Task# | The number assigned to the transaction. |
+------------------+--------------------------------------------------+
| Program | The main program name. |
+------------------+--------------------------------------------------+
| Term | The CICS terminal name. |
+------------------+--------------------------------------------------+
| LUName | The VTAM LU name. |
+------------------+--------------------------------------------------+
| Userid | The userid that executed the transaction. |
+------------------+--------------------------------------------------+
| EICnt | The number of EXEC Interface requests. |
+------------------+--------------------------------------------------+
| EITrace | The name of the EXEC Interface trace definition |
| | that requested EXEC CICS interface requests |
| | to be monitored. |
+------------------+--------------------------------------------------+
| TraceLvl | The level of trace information recorded for |
| | CICS EXEC Interface requests. |
| | |
| | Possible values are: |
| | |
| | SUMMARY - EXEC Interface requests are |
| | summarized by requesting program |
| | and EXEC CICS request type. |
| | |
| | DETAIL - Each individual EXEC Interface |
| | request is recorded without |
| | summarization. |
| | |
+------------------+--------------------------------------------------+
| Lifetime | The life time of a transaction. |
+------------------+--------------------------------------------------+
| CPUtime | The cpu time used by a transaction. |
+------------------+--------------------------------------------------+
| Abnd | An abend code. |
+------------------+--------------------------------------------------+
| LPARName | LPAR name. |
+------------------+--------------------------------------------------+
| ONetwork | Origin network id. |
+------------------+--------------------------------------------------+
| OApplid | Origin applid. |
+------------------+--------------------------------------------------+
| OTran | Origin transaction id. |
+------------------+--------------------------------------------------+
| OTask# | Origin task number. |
+------------------+--------------------------------------------------+
| OFac | Origin facility name. |
+------------------+--------------------------------------------------+
| CICS | The CICS version number. |
+------------------+--------------------------------------------------+
| Length | The record length. |
+------------------+--------------------------------------------------+
| BlockID | Block ID assigned to the log record. |
+------------------+--------------------------------------------------+
| SubRec | Sub-record number within a block. |
+------------------+--------------------------------------------------+
| CmpLen | Length of the compressed record. |
+------------------+--------------------------------------------------+
| Cmp% | Compression percentage. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DRO | Delete records older than the entry selected. |
| | Invokes the LGDRO command. |
+------------------+--------------------------------------------------+
| PRint | Displays the detail screen for a record, prints |
| | the detail report to a sysout data set and then |
| | returns to the display screen. If a SYSOUT |
| | print data set was not open this line command |
| | will cause it to be opened. All subsequent |
| | PRINT line commands will print to the same |
| | SYSOUT data set until a PRINT CLOSE command is |
| | issued or until the session terminates. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Dump | Dump the contents of a record. |
+------------------+--------------------------------------------------+
| SD | Select and dump. |
| | |
| | A detailed report followed by a dump of the |
| | contents of the record is displayed. |
+------------------+--------------------------------------------------+
| Select | Display the detail screen for a record. |
| | Detail report information |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| BACkward | Read the previous block of records in the log |
| PREVious | starting with the first record displayed on the |
| | screen. The number of records read is |
| | controlled by the LINES option, which can be set |
| | using the OPTIONS subcommand. |
+------------------+--------------------------------------------------+
| EOF | Go to the end of the log. |
| EOL | |
+------------------+--------------------------------------------------+
| FORward | Read the next block of records in the log |
| NEXT | starting with the last record displayed on the |
| | screen. The number of records read is |
| | controlled by the LINES option, which can be set |
| | using the OPTIONS subcommand. |
+------------------+--------------------------------------------------+
| OPTions | Set and display miscellaneous command options. |
+------------------+--------------------------------------------------+
| POSition | Position to a time and date. |
| | |
| | Syntax : POSITION time [date] |
| | |
| | time - The time value must be specified |
| | using the time format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | If "*" is specified, the current |
| | time will be used. |
| | |
| | The time value can also be |
| | specified using one of the |
| | following values: |
| | 12AM | 1AM | 2AM | ... | 11AM |
| | 12PM | 1PM | 2PM | ... | 11PM |
| | NOON | MIDNIGHT |
| | |
| | Query current time format |
| | |
| | date - The date value must be specified |
| | using the date format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | If "*" is specified, the current |
| | date will be used. |
| | |
| | Query current date format |
| | |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| TOF | Go to the top of the log. |
| TOL | |
+------------------+--------------------------------------------------+
| FILTER | Display a "filter" screen to allow the entering |
| | command syntax parameters to filter the data. |
+------------------+--------------------------------------------------+

OPTIONS Subcommand

The OPTIONS subcommand sets and displays miscellaneous command


options.

Entering the OPTIONS subcommand with no parameters displays the


current option values.

Multiple option values can be entered as a single command.


OPTIONS Subcommand format

+------------------+--------------------------------------------------+
| OPTIONS | [options] |
+------------------+--------------------------------------------------+

OPTIONS Subcommand Parameter Values

+------------------+--------------------------------------------------+
| Value | Explanation |
+------------------+--------------------------------------------------+
| LINEs | Specifies the maximum number of data rows to |
| | be displayed. |
| | |
| | Syntax : OPTIONS LINES count |
| | |
| | Default : 25000 |
| | Minimum : 1 |
| | Maximum : 1000000 |
| | |
+------------------+--------------------------------------------------+
| LIMit | Specifies the maximum number of records to be |
| | read. |
| | |
| | Syntax : OPTIONS LIMIT count |
| | |
| | Default : 1000000 |
| | |
+------------------+--------------------------------------------------+
| PERiod | Specifies the time period for which records are |
| | to be displayed. |
| | |
| | Syntax : OPTIONS PERIOD hh:mm:ss |
| | |
| | Default : 0 (unlimited) |
| | |
| | Example values: |
| | |
| | NONE - No period (unlimited) |
| | 0 - No period (unlimited) |
| | 0.500000 - 0.5 seconds |
| | 60 - 60 seconds |
| | 120Sec - 120 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | 1Days - 1 day |
| | 1MONths - 1 month |
| | 1Years - 1 year |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| CUSHion | Specifies the time period cushion for which |
| | records are to be read for display. |
| | |
| | Data records stored in an MVS log stream are |
| | sequenced or sorted based on the actual time |
| | the record was written to the stream. |
| | |
| | This does not guarantee that the records |
| | are sorted in a time sequence based on the |
| | date and time information that is potentially |
| | contained within each record. |
| | |
| | For this reason, when a user wants to display |
| | a specific time period of data, additional |
| | records must be read on the front and back |
| | end of the read process to ensure that the |
| | records that might be out of sequence are |
| | included. |
| | |
| | The time period cushion specifies the extra |
| | records to be read. |
| | |
| | Syntax : OPTIONS CUSHION hh:mm:ss |
| | |
| | Example Cushion: |
| | |
| | Start time: 8AM |
| | Period : 1 Hour |
| | Cushion : 5 minutes |
| | |
| | Read Begin : 07:55:00 |
| | -- Discard records |
| | Display Begin : 08:00:00 |
| | -- Display records |
| | Display End : 09:00:00 |
| | -- Discard records |
| | Read End : 09:05:00 |
| | |
| | Example values: |
| | |
| | NONE - No cushion |
| | 0 - No cushion |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| ELAPsed | Specifies the elapsed time limit for reading |
| ELAPsedlimit | or searching the log streams for desired data. |
| | |
| | If the log stream being searched is very large, |
| | the search time required can be substantial. |
| | This is especially true if a large number of |
| | data LINES has been requested and the number |
| | of data records that would satisfy the search |
| | request are spread across the entire log stream. |
| | |
| | The log browse search will be interrupted |
| | when the elapsed time limit is reached. |
| | |
| | The search can be continued using the |
| | subcommands: NEXT or PREVIOUS |
| | |
| | Syntax : OPTIONS ELAPSED hh:mm:ss |
| | |
| | Default : 00:00:30 |
| | |
| | Example values: |
| | |
| | NONE - No limit |
| | 0 - No limit |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| RECORDTime | Specifies whether the "start" or "end" date |
| RECTime | and time should be used for the records. |
| | |
| | Not all records have a start and an end time. |
| | |
| | Records that are interval based typically do |
| | have a start and end time. |
| | |
| | Records that are event based typically do not. |
| | |
| | Syntax : OPTIONS RECTIME END|START |
| | |
| | Valid values are: |
| | |
| | END (default) |
| | START |
| | |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC |
| | variable. The variable created or updated is |
| | named SYSV_OPTIONS_cmdname. EXTRACT is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. EXTRACT can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+------------------+--------------------------------------------------+
| FILTER | Specifies that the "filter" display screen |
| | is to be displayed to allow the entering of |
| | command syntax parameters. |
| | |
| | The "filter" display screen will be displayed |
| | each time the command is invoked unless the |
| | NOFILTER parameter is entered as part of the |
| | primary command syntax. |
| | |
| | Syntax : OPTIONS FILTER |
| | |
+------------------+--------------------------------------------------+
| NOFILTER | Specifies that the "filter" display screen |
| | is not to be displayed. |
| | |
| | The NOFILTER option can be overridden by |
| | entering the FILTER parameter as part of the |
| | primary command syntax. |
| | |
| | The subcommand FILTER can also be used to |
| | display the "filter" display screen. |
| | |
| | Syntax : OPTIONS NOFILTER |
| | |
+------------------+--------------------------------------------------+
| RESET | Request to option values to the defaults. |
| | |
| | Syntax : OPTIONS RESET |
| | |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Related Information

SYSVIEW Usage of MVS Log Streams

Security Requirements

The display of log record information can be controlled


by security definitions. The number of security calls can
be large. Two security calls are made for each log record
to verify the authorization to display the jobname and
transaction ID. The security checks are also performed
when the log record is selected for detailed display.

To enable security validation for CICS log displays, set


the following options in the parmlib member:

sysview.CNM4BPRM(OPTIONS)

SECURE-CICSLOG-BY-JOBNAME Yes
SECURE-CICSLOG-BY-TRAN Yes

If the security option for "Display Unauthorized Jobs"


is set to YES, then the security check for the jobname
is bypassed at the summary screen level. This means that
summary information can be displayed for all records,
but detailed information is controlled by security
definitions. This can reduce the number of security
checks being made.

For security requirements, follow the link:

CEITLOG command security


CEITRACE

CEITRACE Command

The CEITRACE command allows a user to display and modify definitions


that control the monitoring or tracing of CICS EXEC Interface
requests. These definitions are only used if configuration option
TRANSACTION-DATA-EXECCICS displayed in the Information area is set
to a value of CEITRACE.

Definitions can be added or maintained here (warm start) or


in parmlib member CEITRACE (cold start).

CICS EXEC Interface trace definitions are used to determine if the


monitoring performed for a CICS transaction should include the
recording of EXEC Interface requests.

SYSVIEW creates an SMF record for each CICS transaction that is


monitored. If CICS EXEC Interface requests are being monitored
or traced, those traced requests will be included in the CICS
transaction record.

Multiple definitions can be created that control which transactions


are to be monitored for CICS EXEC Interface requests.

A single set of definitions is used for all CICS regions being


monitored by SYSVIEW on the current system. The definitions
can be enabled or disabled as needed.

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CEITRACE | function [parameters] |
| | |
| +--------------------------------------------------+
| | |
| | Function Parameters |
| | ----------- ------------------------------------ |
| | ADDLINE |
| | NOADDLINE |
| | |
| | ADD [ name [ jobname tran terminal |
| | userid status tracelvl |
| | tracelim matchlim ] ] |
| | |
| | DELETE name | * |
| | |
| | DISABLE name |
| | |
| | EMPTY |
| | |
| | ENABLE name |
| | |
| | EXPORT dataset.name(member) |
| | |
| | LOAD member |
| | |
| | RELOAD [ blank | * | WARM ] |
| | [ member ] |
| | [ DATALIB ] |
| | [ COLD ] |
| | |
| | RESET name |
| | |
| | SAVE |
| | |
+------------------+--------------------------------------------------+

If SELECT is used with this command, the dummy input line for adding
new definitions always displays. The dummy add line is being excluded
from the select process.

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| ADDLINE | Specify whether the "?Add" data line should |
| NOADDLINE | be displayed. |
| | |
| | The "?Add" line can be used to create a new |
| | definition. It may be desirable to exclude the |
| | "?Add" data line when the data is being |
| | displayed using a non-3270 interface. |
| | |
+------------------+--------------------------------------------------+
| ADD | Add new definition. |
| | Default values are highlighted. |
| | |
| | Parameters: |
| | name - Definition name. 1-16 characters |
| | |
| | jobname - CICS jobname |
| | The jobname can be specified as: |
| | * Specific CICS jobname |
| | * Generic CICS jobname |
| | * Logical group name containing |
| | a list of CICS jobnames. |
| | Logical group type = CICSPLEX |
| | Syntax: ]group |
| | |
| | tran - CICS transaction ID |
| | The transaction can be specified |
| | as: |
| | * Specific transaction ID |
| | * Generic transaction ID |
| | * Logical group name containing |
| | a list of CICS transactions. |
| | Logical group type = CICSTRAN |
| | Syntax: ]group |
| | |
| | terminal - CICS terminal ID or LUName |
| | |
| | userid - The userid assigned to an |
| | executing transaction |
| | |
| | status - Definition status. |
| | Valid values are: |
| | * DISABLED |
| | * ENABLED |
| | |
| | tracelvl - EXEC Interface trace level |
| | Valid values are: |
| | * SUMMARY |
| | * DETAIL |
| | |
| | tracelim - The trace segment limit value. |
| | The value specifies the maximum |
| | number of EXEC CICS trace |
| | request segments that can be |
| | captured for a transaction. |
| | Valid values are: |
| | * Minimum - 1 |
| | * Maximum - 100000 |
| | * Default - 1000 |
| | |
| | matchlim - The match limit. After the match |
| | limit has been reached the |
| | definition will be disabled. |
| | Valid values are: |
| | * 0 or NONE - No limit |
| | * 1 - nnnnnnnn |
| | |
| | If no parameters are specified then a |
| | definition panel will be displayed. |
| | |
+------------------+--------------------------------------------------+
| DELETE | Delete an existing definition. |
| | |
| | Parameters: |
| | name - Definition name. |
| | |
| | If the "name" is specified as "*" then |
| | all definitions will be deleted. |
| | |
+------------------+--------------------------------------------------+
| DISABLE | Disable a definition. |
| | |
| | Parameters: |
| | name - Definition name. |
| | |
| | Disabling a definition does not modify |
| | other attributes of the definition. |
| | |
+------------------+--------------------------------------------------+
| EMPTY | Delete all definitions. |
| | |
| | Syntax: CEITRACE EMPTY |
| | |
+------------------+--------------------------------------------------+
| ENABLE | Enable a definition. |
| | |
| | Parameters: |
| | name - Definition name. |
| | |
+------------------+--------------------------------------------------+
| EXPORT | Exports definitions to a specific member of |
| | a data set. |
| | |
| | Syntax: EXPORT member |
| | dsname(member) |
| | |
| | Parameter Description |
| | ---------- --------------------------------- |
| | member The name of the member to be |
| | saved. |
| | |
| | dsname The data set name where the |
| | specified member is saved. |
| | |
| | The data set name can be |
| | specified as a fully qualified |
| | data set name or using one of the |
| | following special keywords: |
| | |
| | Keyword Description |
| | ---------- ------------------------------- |
| | USER Uses the optional data set name |
| | defined in the user profile |
| | for the library type PARMLIB. |
| | |
| | Example: USER(member) |
| | |
| | SITE Uses the optional site PARMLIB |
| | data set that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITE(member) |
| | |
| | SYSTEM Uses the system PARMLIB data set |
| | that is defined in the system |
| | configuration options parmlib |
| | member: GSVXGSVX |
| | |
| | Example: SYSTEM(member) |
| | |
| | SITESYSTEM Uses the first defined data |
| | SITE.SYSTEM set from the following list |
| | * of eligible data set names: |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITESYSTEM(member) |
| | SITE.SYSTEM(member) |
| | *(member) |
| | |
| | USERSITE Uses the first defined data |
| | USER.SITE set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSITE(member) |
| | USER.SITE(member) |
| | |
| | USERSYSTEM Uses the first defined data |
| | USER.SYSTEM set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSYSTEM(member) |
| | USER.SYSTEM(member) |
| | |
| | The above keywords can be cursor selected |
| | invoking a hyperlink to the PARMLIB command |
| | showing the available data sets for the |
| | keyword. |
| | |
+------------------+--------------------------------------------------+
| LOAD | Load definitions. |
| | |
| | Existing definitions will NOT be deleted. |
| | |
| | member - Load definitions from the |
| | specified parmlib member. |
| | |
| | Syntax: CEITRACE LOAD member |
| | |
+------------------+--------------------------------------------------+
| RELOAD | Reload definitions. |
| | |
| | Existing definitions will be deleted. |
| | |
| | * - Reload definitions from the |
| | blank persistent data store. If the |
| | WARM object is not found in the |
| | persistent data store, reload |
| | the definitions from parmlib. |
| | |
| | The parmlib member to be used |
| | is: CEITRACE |
| | |
| | DATALIB - Reload definitions from the |
| | persistent data store. |
| | |
| | COLD - Reload definitions from parmlib. |
| | |
| | member - Reload definitions from the |
| | specified parmlib member. |
| | |
+------------------+--------------------------------------------------+
| RESET | Reset definition statistics. |
| | |
+------------------+--------------------------------------------------+
| SAVE | Save the definitions to the persistent data |
| | store. |
| | |
| | The definitions will be stored using a |
| | DataID = "CEITRACE". |
| | |
| | Persistent store DATALIB list |
| | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Status | Indicates whether CICS EXEC Interface tracing |
| | is enabled in the current target CICS region. |
| | |
| | Possible values are: |
| | |
| | ENABLED - EI tracing is enabled |
| | |
| | DISABLED - EI tracing is disabled |
| | |
| | n/a - The current target address space |
| | is not a CICS address space. |
| | |
+------------------+--------------------------------------------------+
| Tracing | Indicates whether CICS EXEC Interface requests |
| | are being processed and traced. |
| | |
| | Possible values are: |
| | |
| | ACTIVE - Tracing is active for the current |
| | target CICS address space. |
| | |
| | INACTIVE - Tracing is inactive for the |
| | current target CICS address space. |
| | |
| | n/a - The current target address space |
| | is not a CICS address space. |
| | |
+------------------+--------------------------------------------------+
| Transaction-Data | Displays the current configuration option |
| -EXECCICS | value for: Transaction-Data-EXECCICS |
| | |
| | The option can be viewed and modified using |
| | the CCONFIG command. |
| | |
| | Possible values are: |
| | |
| | NO - Do not collect data |
| | |
| | YES - Collect data. The collected data |
| | will be summarized by requesting |
| | program name and EXEC CICS |
| | request. EXEC Interface requests |
| | will be collected for all |
| | transactions and the CEITRACE |
| | definitions will not be used. |
| | |
| | CEITRACE - Data collection will be enabled. |
| | EXEC Interface trace definitions |
| | will be used to determine if |
| | EXEC Interface requests will be |
| | collected for a specific |
| | transaction. |
| | |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Name | The name of the definition. |
| | |
| | If the definition is enabled the name will be |
| | highlighted. |
| | |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname to which the definition is |
| | to be applied. |
| | |
| | The jobname can be specified as: |
| | |
| | * Specific CICS jobname |
| | * Generic CICS jobname |
| | * Logical group name containing a list of |
| | CICS jobnames. |
| | Logical group type = CICSPLEX |
| | Syntax: ]group |
| | |
+------------------+--------------------------------------------------+
| Tran | The CICS transaction ID. |
| | |
| | The transaction ID can be specified as: |
| | |
| | * Specific transaction ID |
| | * Generic transaction ID |
| | * Logical group name containing a list of |
| | CICS transactions. |
| | Logical group type = CICSTRAN |
| | Syntax: ]group |
| | |
| | The specified value is compared with the |
| | transaction ID (TRAN) or the originating |
| | transaction ID (OTRAN) of a given transaction |
| | |
+------------------+--------------------------------------------------+
| Terminal | The CICS terminal name. |
| | |
| | The terminal can be specified as: |
| | |
| | * CICS terminal ID |
| | * LUName |
| | * Specific terminal |
| | * Generic terminal |
| | |
+------------------+--------------------------------------------------+
| Userid | The userid assigned to an executing |
| | transaction. |
| | |
| | The userid can be specified as: |
| | |
| | * Specific userid |
| | * Generic userid |
| | |
+------------------+--------------------------------------------------+
| Status | The status of the definition. |
| | |
| | Valid values are: |
| | |
| | ENABLED |
| | DISABLED |
| | |
| | Only enabled definitions will be evaluated |
| | for the monitoring of CICS EXEC Interface |
| | requests. |
| | |
+------------------+--------------------------------------------------+
| TraceLvl | The level of trace information to be recorded |
| | for CICS EXEC Interface requests. |
| | |
| | Valid values are: |
| | |
| | SUMMARY - EXEC Interface requests will be |
| | summarized by the following: |
| | |
| | Program name |
| | Program offset |
| | EXEC CICS request type |
| | |
| | DETAIL - Each individual EXEC Interface |
| | request will be recorded without |
| | summarization. |
| | |
| | ** Notes ** |
| | |
| | SUMMARY is the recommended level of trace. |
| | |
| | The DETAIL trace level can produce more |
| | overhead than SUMMARY. The overhead should |
| | not be seen as significant if the tracing |
| | periods are performed on an as needed basis. |
| | DETAIL trace level will produce |
| | significantly larger CICS transaction detail |
| | records to be logged. This will vary based |
| | on the number of EXEC Interface requests |
| | being made by a transaction. |
| | |
+------------------+--------------------------------------------------+
| TraceLim | The trace segment limit value. |
| | |
| | The value specifies the maximum number of |
| | EXEC CICS trace request segments that can be |
| | captured for a transaction. |
| | |
| | Trace Level |
| | |
| | SUMMARY - A single trace segment contains |
| | the summarization of EXEC CICS |
| | requests based on the following |
| | key: |
| | |
| | Program name |
| | Program offset |
| | EXEC CICS request type |
| | |
| | DETAIL - A single trace segment contains |
| | an individual EXEC CICS request. |
| | |
| | Valid values are: |
| | |
| | Minimum - 1 |
| | Maximum - 100000 |
| | Default - 1000 |
| | |
| | If the limit is reached, requests that would |
| | require a new segment will be discarded. |
| | |
+------------------+--------------------------------------------------+
| MatchLim | The definition match limit. After the specified |
| | match limit has been reached the definition |
| | will be disabled. |
| | |
| | Valid values are: |
| | |
| | 0 or NONE - No limit |
| | |
| | 1 - nnnnnnnn - Limit value |
| | |
+------------------+--------------------------------------------------+
| MatchCnt | The current number of transactions that have |
| | matched the definition up to the defined |
| | match limit. |
| | |
+------------------+--------------------------------------------------+
| UseCount | The number of transactions that have matched |
| | the definition. The definition was used to |
| | enable tracing for a transaction. |
| | |
+------------------+--------------------------------------------------+
| Date | The date and time the definition was last |
| Time | used to trace a transaction. |
+------------------+--------------------------------------------------+
| MatchJob | Indicates whether the definition matches the |
| | current target jobname. |
| | |
| | Possible values are: |
| | |
| | YES - The definition applies to or matches |
| | the current target jobname and will |
| | be used to determine if a |
| | transaction is to be traced. |
| | |
| | blanks - The definition does not apply to or |
| | match the current target jobname |
| | and will not be used to determine |
| | if a transaction is to be traced. |
| | |
| | If the current target jobname |
| | displayed in the information section |
| | is not a monitored CICS jobname, |
| | "blanks" will also be displayed. |
| | |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Add | Add a new definition. |
| | This line command can only be entered on the |
| | "?Add" input line. |
+------------------+--------------------------------------------------+
| Copy | Copy the definition attributes and create a |
| | new definition. |
+------------------+--------------------------------------------------+
| DELete | Delete the selected definition. |
+------------------+--------------------------------------------------+
| DISable | Disable the selected definition. |
+------------------+--------------------------------------------------+
| Edit | Edit the selected definition. |
+------------------+--------------------------------------------------+
| ENAble | Enable the selected definition. |
+------------------+--------------------------------------------------+
| RESet | Reset the definition statistics. |
+------------------+--------------------------------------------------+

Navigation Line Commands


+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Group | Display CICS logical group definitions. |
+------------------+--------------------------------------------------+
| Log | Display the transaction records in the CICS |
| | transaction log that contain EXEC Interface |
| | trace information for the selected definition |
| | name. |
| | |
| | Available records for the previous 24 hours |
| | will be displayed (if any). |
| | |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| ADD | Add new definition. |
| | Default values are highlighted. |
| | |
| | Syntax: ADD [ name [ jobname tran terminal |
| | userid status tracelvl |
| | tracelim matchlim ] ] |
| | |
| | Parameters: |
| | name - Definition name. 1-16 characters |
| | |
| | jobname - CICS jobname |
| | The jobname can be specified as: |
| | * Specific CICS jobname |
| | * Generic CICS jobname |
| | * Logical group name containing |
| | a list of CICS jobnames. |
| | Logical group type = CICSPLEX |
| | Syntax: ]group |
| | |
| | tran - CICS transaction ID |
| | The transaction can be specified |
| | as: |
| | * Specific transaction ID |
| | * Generic transaction ID |
| | * Logical group name containing |
| | a list of CICS transactions. |
| | Logical group type = CICSTRAN |
| | Syntax: ]group |
| | |
| | terminal - CICS terminal ID or LUName |
| | |
| | userid - The userid assigned to an |
| | executing transaction |
| | |
| | status - Definition status |
| | Valid values are: |
| | * DISABLED |
| | * ENABLED |
| | |
| | tracelvl - EXEC Interface trace level |
| | Valid values are: |
| | * SUMMARY |
| | * DETAIL |
| | |
| | tracelim - The trace segment limit value. |
| | The value specifies the maximum |
| | number of EXEC CICS trace |
| | request segments that can be |
| | captured for a transaction. |
| | Valid values are: |
| | * Minimum - 1 |
| | * Maximum - 100000 |
| | * Default - 1000 |
| | |
| | matchlim - The match limit. After the match |
| | limit has been reached the |
| | definition will be disabled. |
| | Valid values are: |
| | * 0 or NONE - No limit |
| | * 1 - nnnnnnnn |
| | |
| | If parameters are not specified a definition |
| | panel will be displayed. |
| | |
+------------------+--------------------------------------------------+
| DELETE | Delete an existing definition. |
| | |
| | Syntax: DELETE name |
| | |
| | Parameters: |
| | name - Definition name. |
| | |
| | If the "name" is specified as "*" then |
| | all definitions will be deleted. |
| | |
+------------------+--------------------------------------------------+
| DISABLE | Disable a definition. |
| | |
| | Syntax: DISABLE name |
| | |
| | Parameters: |
| | name - Definition name. |
| | |
| | Disabling a definition does not modify |
| | other attributes of the definition. |
| | |
+------------------+--------------------------------------------------+
| EMPTY | Delete all definitions. |
| | |
| | Syntax: EMPTY |
| | |
+------------------+--------------------------------------------------+
| ENABLE | Enable a definition. |
| | |
| | Syntax: ENABLE name |
| | |
| | Parameters: |
| | name - Definition name. |
| | |
+------------------+--------------------------------------------------+
| EXPORT | Exports definitions to a specific member of |
| | a data set. |
| | |
| | Syntax: EXPORT member |
| | dsname(member) |
| | |
| | Parameter Description |
| | ---------- --------------------------------- |
| | member The name of the member to be |
| | saved. |
| | |
| | dsname The data set name where the |
| | specified member is saved. |
| | |
| | The data set name can be |
| | specified as a fully qualified |
| | data set name or using one of the |
| | following special keywords: |
| | |
| | Keyword Description |
| | ---------- ------------------------------- |
| | USER Uses the optional data set name |
| | defined in the user profile |
| | for the library type PARMLIB. |
| | |
| | Example: USER(member) |
| | |
| | SITE Uses the optional site PARMLIB |
| | data set that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITE(member) |
| | |
| | SYSTEM Uses the system PARMLIB data set |
| | that is defined in the system |
| | configuration options parmlib |
| | member: GSVXGSVX |
| | |
| | Example: SYSTEM(member) |
| | |
| | SITESYSTEM Uses the first defined data |
| | SITE.SYSTEM set from the following list |
| | * of eligible data set names: |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITESYSTEM(member) |
| | SITE.SYSTEM(member) |
| | *(member) |
| | |
| | USERSITE Uses the first defined data |
| | USER.SITE set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSITE(member) |
| | USER.SITE(member) |
| | |
| | USERSYSTEM Uses the first defined data |
| | USER.SYSTEM set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSYSTEM(member) |
| | USER.SYSTEM(member) |
| | |
| | The above keywords can be cursor selected |
| | invoking a hyperlink to the PARMLIB command |
| | showing the available data sets for the |
| | keyword. |
| | |
+------------------+--------------------------------------------------+
| LOAD | Load definitions. |
| | |
| | Existing definitions will NOT be deleted. |
| | |
| | Syntax: LOAD member |
| | |
| | member - Load definitions from the |
| | specified parmlib member. |
| | |
+------------------+--------------------------------------------------+
| RELOAD | Reload definitions. |
| | |
| | Existing definitions will be deleted. |
| | |
| | Syntax: RELOAD member |
| | |
| | Parameters: |
| | * - Reload definitions from the |
| | blank persistent data store. If the |
| | WARM object is not found in the |
| | persistent data store, reload |
| | the definitions from parmlib. |
| | |
| | The parmlib member to be used |
| | is: CEITRACE |
| | |
| | DATALIB - Reload definitions from the |
| | persistent data store. |
| | |
| | COLD - Reload definitions from parmlib. |
| | |
| | member - Reload definitions from the |
| | specified parmlib member. |
| | |
+------------------+--------------------------------------------------+
| RESET | Reset definition statistics. |
| | |
| | Syntax: RESET name |
| | |
| | Parameters: |
| | name - Definition name. |
| | |
+------------------+--------------------------------------------------+
| SAVE | Save the definitions to the persistent data |
| | store. |
| | |
| | The definitions will be stored using a |
| | DataID = "CEITRACE". |
| | |
| | Persistent store DATALIB list |
| | |
+------------------+--------------------------------------------------+
CELEMENT

CELEMENT Command

The command CELEMENT displays information about blocks of storage


allocated and in use by CICS storage management.

Command Syntax

+------------------+--------------------------------------------------+
| CELEMENT | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Subpool | The name of the owning subpool. |
+------------------+--------------------------------------------------+
| Num | The ID number of the subpool. This is a number |
| | from 0 to 255. |
+------------------+--------------------------------------------------+
| Address | The starting address of the allocated storage. |
+------------------+--------------------------------------------------+
| Length | The length of the allocated storage block, in |
| | bytes. |
+------------------+--------------------------------------------------+
| DSAname | The name of the owning Dynamic Storage Area. |
+------------------+--------------------------------------------------+
| Page | The page number within the Dynamic Storage Area |
| | at which the storage resides. |
+------------------+--------------------------------------------------+
| Free | If FREE, then the area has been freed. |
+------------------+--------------------------------------------------+
| Stgv | Storage violation found within control block. |
+------------------+--------------------------------------------------+
| SCA | The address of the SCA control block. |
+------------------+--------------------------------------------------+
| SCE | The address of the SCE control block. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CELLPOOL

CELLPOOL Command

The CELLPOOL command displays information about allocated


storage cell pools.

Command Syntax

+---------------+------------------------------------------------------------+
| CELLPOOL | [asid] |
+---------------+------------------------------------------------------------+

Parameters

+----------------+-----------------------------------------------------------+
| Parameter | Explanation |
+----------------+-----------------------------------------------------------+
| asid | The ASID of the target address space. For details on |
| | specifying an ASID parameter, see the ASID command. If |
| | the ASID parameter is omitted, then the current ASID is |
| | used. |
+----------------+-----------------------------------------------------------+

Information Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Jobname | The jobname of the current address space. |
+---------------+------------------------------------------------------------+
| ASID | The address space ID. |
+---------------+------------------------------------------------------------+
| Jobid | The job identifier. |
+---------------+------------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| PoolId | The cell pool identifier. |
+---------------+------------------------------------------------------------+
| Region | The region containing the cell pool. |
+---------------+------------------------------------------------------------+
| Extnt | The number of extents. |
+---------------+------------------------------------------------------------+
| CSize | The cell size. |
+---------------+------------------------------------------------------------+
| PriNo | The number of cells in primary extent. |
+---------------+------------------------------------------------------------+
| SecNo | The number of cells in secondary extent. |
+---------------+------------------------------------------------------------+
| SPN | The subpool number. |
+---------------+------------------------------------------------------------+
| Key | The protect key of storage. |
+---------------+------------------------------------------------------------+
| FProt | FPROT if the storage is fetch protected and blank if not. |
+---------------+------------------------------------------------------------+
| Fix | FIX if the storage is fixed and blank if not. |
+---------------+------------------------------------------------------------+
| DRef | DREF if the storage is disabled reference and blank if not.|
+---------------+------------------------------------------------------------+
| Owner | The owner of the cell pool. Values can be: |
| | |
| | PRI |
| | SYS |
| | HOME |
| | |
+---------------+------------------------------------------------------------+
| MHdr | MHDR if the cellpool is a multi-header pool. Otherwise |
| | blank. |
| | |
+---------------+------------------------------------------------------------+
| Shr | SHR if a multi-header cellpool allows free cells to be |
| | shared between processors. |
+---------------+------------------------------------------------------------+
| Header | User-supplied header information. |
+---------------+------------------------------------------------------------+
| PPD | The PPD address of the pool. |
+---------------+------------------------------------------------------------+
| TCB | The TCB address of the pool owner. |
+---------------+------------------------------------------------------------+
| ASCB | The ASCB address of the pool owner. |
+---------------+------------------------------------------------------------+

Notes

Global and Local Cell Pools

Global cell pools, those not associated with any address


space, are displayed when the *MASTER* address space is
selected for display. All other address spaces display
only local cell pools.

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. |
+---------------+------------------------------------------------------------+
CEMT

CEMT Command

The CEMT command provides easy method of executing a CICS CEMT


function.

Command Syntax

+------------------+--------------------------------------------------+
| CEMT | [cemt_command_arguments] |
+------------------+--------------------------------------------------+

Parameters

All responses from the CEMT function are logged to the ddname GSVCLOG
file for the corresponding CICS address space.

Related Information

The CCEMT command can be used to display the responses from a


CEMT request. The CCEMT command is SYSTEM and XSYSTEM capable.

Security Requirements

CEMT requests execute under the user context assigned to the


GSVI transaction executing in the CICS address space.

Assign a userid to the GSVI CICS transaction


CENQMOD

CENQMOD Command

The CENQMOD command displays information about CICS enqueue


model definitions.

CICS uses enqueue model resources with z/OS global resource


serialization to provide sysplex-wide protection of resources
that are used by multiple applications.

To see the sysplex enqueues that use z/OS global resource


serialization facilities, you can enter the following commands:

XMVS D GRS,RES=(DFHE*)

qname - specifies a 4-character ENQSCOPE defined by an


ENQMODEL resource.
rname - specifies an ENQNAME defined by an ENQMODEL resource.

ENQUEUE QNAME DFHE=

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CENQMod | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,EnqModel,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| EnqModel | The enqueue module identifier. |
+------------------+--------------------------------------------------+
| Status | The enqueue model status. |
| | |
| | Possible values are: |
| | ENABLED |
| | DISABLED |
| | |
+------------------+--------------------------------------------------+
| Scope | The sysplex-wide ENQUEUE scope qualifier. |
| | A blank value indicates that the enqueue is |
| | local. |
+------------------+--------------------------------------------------+
| EnqName | The enqueue resource name. |
| | |
| | If a CICS enqueue is issued that matches this |
| | name and an enqueue scope was specified, |
| | the enqueue is sysplex-wide and qualified |
| | by the 4-character enqueue scope value. |
+------------------+--------------------------------------------------+
| DefGroup | The source of the resource definition. |
+------------------+--------------------------------------------------+
| InstAgent | The agent that installed the definition. |
+------------------+--------------------------------------------------+
| InstDate | The date and time when the definition was |
| InstTime | installed. |
+------------------+--------------------------------------------------+
| InstUser | The userid that installed the definition. |
+------------------+--------------------------------------------------+
| ChgAgent | The agent that changed the definition. |
+------------------+--------------------------------------------------+
| ChgDate | The date and time when the definition was last |
| ChgTime | changed. |
+------------------+--------------------------------------------------+
| ChgUser | The userid that changed the definition. |
+------------------+--------------------------------------------------+
| ChgLvl | The CICS release of the agent that changed the |
| | definition. |
+------------------+--------------------------------------------------+
| DefDate | The date and time when the definition was |
| DefTime | created. |
+------------------+--------------------------------------------------+
| NQRN | The address of the MQRN control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined


by the RXDISP.&HelpMember command. Other types of
line commands are also available. Follow the links
below for more information.

Special Line Commands


External Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+

Notes
CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CENQPOOL

CENQPOOL Command

The CENQPOOL command displays a list of enqueue pools in use by the


CICS address space.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CENQPOOL | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Pool,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname that owns the resource. |
+------------------+--------------------------------------------------+
| Pool | The name of the enqueue pool. |
+------------------+--------------------------------------------------+
| Requests | The number of enqueue requests in the pool. |
+------------------+--------------------------------------------------+
| Busy | The number of times 'busy' was returned. |
+------------------+--------------------------------------------------+
| Complete | The number of requests that have completed after |
| | waiting. |
+------------------+--------------------------------------------------+
| WaitTime | The total time spent waiting by completed |
| | requests that waited. |
+------------------+--------------------------------------------------+
| LockImm | The number of times 'locked' returned |
| | immediately. |
+------------------+--------------------------------------------------+
| LockWait | The number of times 'locked' returned after |
| | waiting. |
+------------------+--------------------------------------------------+
| Cancel | The number of times the enqueue waiter canceled. |
+------------------+--------------------------------------------------+
| Timeout | The number of times the enqueue waiter timed |
| | out. |
+------------------+--------------------------------------------------+
| Held | The number of enqueues that have been held in |
| | retained state. |
+------------------+--------------------------------------------------+
| HeldTime | The total time that enqueues were held in |
| | retained state. |
+------------------+--------------------------------------------------+
| Shunt | The default action on shunt for enqueues in this |
| | pool. |
+------------------+--------------------------------------------------+
| NQPL | The address of the NQPL control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the CENQUEUE command. Selection is |
| | performed as follows: |
| | |
| | SELECT POOL EQ pool |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CENQPOOL command security


CENQUEUE

CENQUEUE Command

The CENQUEUE command displays a list of resources that are currently


enqueued. The transaction that owns the enqueue as well as the
current transaction waiting on the resource is displayed.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CENQUEUE | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
| | [ All | Conflicts ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
+------------------+--------------------------------------------------+
| All | Display all enqueues. |
+------------------+--------------------------------------------------+
| Conflicts | Display ONLY those enqueues with conflicts. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Rname,A,WaitTime,D

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Rname | The resource that is being enqueued, in |
| | character format. Only the first 32 characters |
| | of the resource are displayed. The resource |
| | length can be up to 255 characters. |
+------------------+--------------------------------------------------+
| Status | The status of the enqueued resource. |
| | Possible values are: |
| | OWN Owner of resource |
| | OWNWAIT Owner of resource with waiters |
| | WAIT Waiting for resource |
+------------------+--------------------------------------------------+
| Tran | The CICS transaction name. |
+------------------+--------------------------------------------------+
| Task# | The CICS transaction number. |
+------------------+--------------------------------------------------+
| OTrn | The CICS owning transaction name. |
+------------------+--------------------------------------------------+
| OTask | The CICS owning transaction number. |
+------------------+--------------------------------------------------+
| WaitTime | The amount of time that the transaction has been |
| | waiting for the resource. |
| | |
| | For "Status" = OWN or OWNWAIT, the value |
| | is the elapsed time that the enqueue has been |
| | held. |
+------------------+--------------------------------------------------+
| Len | The length of the rname. |
+------------------+--------------------------------------------------+
| Type | The enqueue type. |
| | Possible values are: |
| | ACTIVE |
| | RETAINED |
+------------------+--------------------------------------------------+
| TranHeld | The transaction held count. |
+------------------+--------------------------------------------------+
| UOWHeld | The UOW held count. |
+------------------+--------------------------------------------------+
| Locked | The number of lock failures. |
+------------------+--------------------------------------------------+
| Retained | The amount of time the resource has been |
| | retained. |
+------------------+--------------------------------------------------+
| Shunt | Indicates that the owning UOW is shunted. |
+------------------+--------------------------------------------------+
| Owner | The owner of the enqueue. |
| | Possible values are: |
| | TASK |
| | UOW |
+------------------+--------------------------------------------------+
| OwnerID | The owner ID of the enqueue. |
| | Possible values based on Owner value: |
| | TASK - address of TASENTRY |
| | UOW - local UOW ID |
+------------------+--------------------------------------------------+
| Pool | The enqueue pool name. |
+------------------+--------------------------------------------------+
| NQEA | The address of the CICS NQEA control block. |
+------------------+--------------------------------------------------+
| CkSumToken | Checksum token used to represent a unique value |
| | for RNames that display hex values. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands
+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CENQUEUE command security


CEPBS

CEPBS Command

The CEPBS command displays the list of CICS exit program blocks.
These blocks define exit points associated with global and task
related user exits.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CEPBS | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Exitname,A,QualName,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Exitname | The name of exit that has been defined to CICS. |
+------------------+--------------------------------------------------+
| QualName | The qualifier for the task related exit's name. |
+------------------+--------------------------------------------------+
| Count | The exit program use count. |
+------------------+--------------------------------------------------+
| Module | The name of the module that has been associated |
| | with the exit. |
+------------------+--------------------------------------------------+
| Address | The address of the module. |
+------------------+--------------------------------------------------+
| Gbl-Addr | The address of the global work area assigned to |
| | the exit. |
+------------------+--------------------------------------------------+
| GblLen | The length of the global area, in bytes. |
+------------------+--------------------------------------------------+
| TM | The TRUE's program mode. |
+------------------+--------------------------------------------------+
| GM | The GLUE's program mode. |
+------------------+--------------------------------------------------+
| Instance | The instance count. |
| | The instance count can increase when an |
| | exit name is enabled multiple times. |
+------------------+--------------------------------------------------+
| GCount | The global area use count. |
+------------------+--------------------------------------------------+
| TCount | The Tie-Count. |
+------------------+--------------------------------------------------+
| ACount | The activation count. |
+------------------+--------------------------------------------------+
| Start | Specifies that the exit program has been |
| | started. |
+------------------+--------------------------------------------------+
| Load | Specifies that the exit program has been loaded. |
| | The program was loaded by a user, and should not |
| | be deleted when disabled. |
+------------------+--------------------------------------------------+
| Dis | Specifies that the exit program has been |
| | disabled. |
+------------------+--------------------------------------------------+
| Resync | EXEC RESYNC has been issued. |
+------------------+--------------------------------------------------+
| LinkMode | The link edit mode has been specified. |
+------------------+--------------------------------------------------+
| InDoubt | The indoubt wait option has been specified. |
+------------------+--------------------------------------------------+
| Purge | This exit is purgeable. |
+------------------+--------------------------------------------------+
| EPB | The address of the EPB control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CFCACHE

CFCACHE Command

The CFCACHE command displays cache storage class statistics


for cache structures allocated in coupling facilities.

Command Syntax

+---------------+-----------------------------------------------------+
| CFCACHE | [option] |
+---------------+-----------------------------------------------------+

Parameters

+---------------+-----------------------------------------------------+
| Parameter | Explanation |
+---------------+-----------------------------------------------------+
| option | Specifies that cache storage classes are to be |
| | displayed. Valid values are: |
| | |
| | All All storage classes |
| | Used Only used storage classes |
| | |
| | If no option parameter is specified, then the |
| | default set by the OPTIONS subcommand is used. The |
| | initial default is ALL. |
+---------------+-----------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Sysplex Name | The name of the sysplex. |
+------------------+--------------------------------------------------+
| Configuration | The sysplex configuration. |
+------------------+--------------------------------------------------+
| Interval | The performance monitoring interval in seconds. |
| | This value is the time between the last two |
| | screen refreshes, or two seconds, whichever is |
| | larger. |
+------------------+--------------------------------------------------+
| Policy | The active CFRM policy name. |
+------------------+--------------------------------------------------+
| Start | The date and time the CFRM policy was activated. |
+------------------+--------------------------------------------------+
| Update | The date and time the CFRM policy was last |
| | updated. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| StrName | The structure name. |
+------------------+--------------------------------------------------+
| StrStat | The structure status. Valid values are: |
| | |
| | ALLOC Allocated, active, and in use |
| | NOSYSCON No systems have connectivity |
| | FAILED Structure has failed |
| | RBLD_OLD Structure rebuild is in progress |
| | and this is the old structure |
| | RBLD_NEW Structure rebuild is in progress |
| | and this is the new structure |
| | TRANSIT Status is in transition |
| | HOLDING Structure is in holding state |
| | DUMPING Structure is being dumped |
+------------------+--------------------------------------------------+
| Cls | The cache storage class. |
+------------------+--------------------------------------------------+
| Tot | The total number of storage classes within |
| | the structure. |
+------------------+--------------------------------------------------+
| RHITC | The read hit count. |
+------------------+--------------------------------------------------+
| RMDHC | The read miss, directory hit count. |
+------------------+--------------------------------------------------+
| RMASC | The read miss, assignment suppressed count. |
+------------------+--------------------------------------------------+
| RMNAC | The read miss, name assigned count. |
+------------------+--------------------------------------------------+
| RMTFC | The read miss, target storage class full count. |
+------------------+--------------------------------------------------+
| WHB0C | The write hit change Bit 0 count. |
+------------------+--------------------------------------------------+
| WHB1C | The write hit change Bit 1 count. |
+------------------+--------------------------------------------------+
| WMNRC | The write miss, not registered count. |
+------------------+--------------------------------------------------+
| WMISC | The write miss, invalid state count. |
+------------------+--------------------------------------------------+
| WMTFC | The write miss, target storage class full count. |
+------------------+--------------------------------------------------+
| DERCC | The directory entry reclaim count. |
+------------------+--------------------------------------------------+
| DTERC | The data entry reclaim count. |
+------------------+--------------------------------------------------+
| XIDRC | The cross invalidate directory reclaim count. |
+------------------+--------------------------------------------------+
| XIWRC | The cross invalidate write count. |
+------------------+--------------------------------------------------+
| XINIC | The cross invalidate name invalidation count. |
+------------------+--------------------------------------------------+
| XICIC | The cross invalidate complement invalidation |
| | count. |
+------------------+--------------------------------------------------+
| COUTC | The Castout Count. |
+------------------+--------------------------------------------------+
| RSMSC | The reference signal miss count. |
+------------------+--------------------------------------------------+
| TSCFC | The target storage class full count. |
+------------------+--------------------------------------------------+
| DENTC | The directory entry count. |
+------------------+--------------------------------------------------+
| DAELC | The data area element count. |
+------------------+--------------------------------------------------+
| TCHGC | The total changed count. |
+------------------+--------------------------------------------------+
| DATAC | The data area count. |
+------------------+--------------------------------------------------+
| CRLSC | The completed reference lists count. |
+------------------+--------------------------------------------------+
| PCRLC | The partially completed reference lists count. |
+------------------+--------------------------------------------------+
| XILRC | The cross invalidate for local cache vector |
| | index replacement count. |
+------------------+--------------------------------------------------+
| WUXIC | The write unchanged with cross invalidate count. |
+------------------+--------------------------------------------------+
| CFName | The coupling facility name. |
+------------------+--------------------------------------------------+
| CFStat | The coupling facility status. Valid values are: |
| | |
| | ACTIVE The coupling facility is active |
| | DELETE Policy change pending that deletes |
| | this coupling facility from the |
| | CFRM active policy when all |
| | allocated structures are gone |
| | RECONCIL A coupling facility to CFRM policy |
| | reconcile is in progress |
| | FAILED The coupling facility has failed |
+------------------+--------------------------------------------------+
| Message | This field contains a message only if there was |
| | an error obtaining the cache statistics for the |
| | storage class. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Cache | Invokes CFCACHE for the selected structure. |
+----------+----------------------------------------------------------+
| COnfig | Invokes CFCONFIG for the selected coupling facility. |
+----------+----------------------------------------------------------+
| List | Invokes CFLIST for the selected coupling facility. |
+----------+----------------------------------------------------------+
| Path | Invokes CFPATH for the selected coupling facility. |
+----------+----------------------------------------------------------+
| PRoc | Invokes CFPROC for the selected coupling facility. |
+----------+----------------------------------------------------------+
| Struct | Invokes CFSTRUCT for the selected structure. |
+----------+----------------------------------------------------------+
| User | Invokes CFUSER for the selected structure. |
+----------+----------------------------------------------------------+
Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| OPTIONS | Display and set CFCACHE options. |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+

OPTIONS Subcommand

Use the OPTIONS subcommand to set and display CFCACHE command display
and processing options

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [cmndopts] |
+---------------+-----------------------------------------------------+
OPTIONS Parameter Values

The following table lists and explains the valid OPTIONS


parameter values. Any number of the values can be specified
in any order. The current settings of all options are always
displayed in response to the OPTIONS subcommand.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| All | Specifies that all cache storage classes be |
| | displayed even if the class has never been used |
| | and all values are zero. ALL is the default. |
+---------------+-----------------------------------------------------+
| Used | Specifies that only those cache storage classes |
| | that have been used (not all values are zero) are |
| | to be displayed. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_CFCACHE. EXTRACT is only valid |
| | when the product is running under a TSO CLIST or |
| | REXX EXEC. EXTRACT can be specified alone or in |
| | combination with any other OPTIONS keywords. |
+---------------+-----------------------------------------------------+
CFCONFIG

CFCONFIG Command

The CFCONFIG command display coupling facility configuration


information.

Command Syntax

+---------------+-----------------------------------------------------+
| CFCONFIG | |
+---------------+-----------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Sysplex Name | The name of the sysplex. |
+------------------+--------------------------------------------------+
| Configuration | The sysplex configuration. |
+------------------+--------------------------------------------------+
| Policy | The active CFRM policy name. |
+------------------+--------------------------------------------------+
| Start | The date and time the CFRM policy was activated. |
+------------------+--------------------------------------------------+
| Update | The date and time the CFRM policy was last |
| | updated. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| CFName | The coupling facility name. |
+------------------+--------------------------------------------------+
| CFStat | The coupling facility status. |
| | Possible values are: |
| | |
| | ACTIVE The coupling facility is active |
| | DELETE Policy change pending that deletes |
| | this coupling facility from the |
| | CFRM active policy when all |
| | allocated structures are gone |
| | RECONCIL A coupling facility to CFRM policy |
| | reconcile is in progress |
| | FAILED The coupling facility has failed |
| | |
+------------------+--------------------------------------------------+
| Mode | The coupling facility mode. |
| | Possible values are: |
| | |
| | SI Single image |
| | PP Physically partitioned |
| | |
+------------------+--------------------------------------------------+
| Confg | The coupling facility configuration. |
| | Possible values are: |
| | |
| | SIDE0 |
| | SIDE1 |
| | |
+------------------+--------------------------------------------------+
| Part | The LPAR partition number if partitioned. |
+------------------+--------------------------------------------------+
| Type | The node type. |
+------------------+--------------------------------------------------+
| Mdl | The model number. |
+------------------+--------------------------------------------------+
| Mfg | The manufacturer. |
+------------------+--------------------------------------------------+
| Pl | The manufacturer plant identifier. |
+------------------+--------------------------------------------------+
| SeqNo | The sequence number. |
+------------------+--------------------------------------------------+
| CpcId | The central processor complex identifier. |
+------------------+--------------------------------------------------+
| Level | The coupling facility architected function |
| | level. |
+------------------+--------------------------------------------------+
| Ident | The coupling facility identifier number. |
+------------------+--------------------------------------------------+
| StrMx | The maximum structure identifier. |
+------------------+--------------------------------------------------+
| TotSz | The total storage size. |
+------------------+--------------------------------------------------+
| TotU | The percent of total size that is in use. |
+------------------+--------------------------------------------------+
| CtlSz | The control storage size. |
+------------------+--------------------------------------------------+
| CtlU | The percent of control storage that is in use. |
+------------------+--------------------------------------------------+
| NctSz | The non-control storage size. |
+------------------+--------------------------------------------------+
| NctU | The percent of non-control storage that is in |
| | use. |
+------------------+--------------------------------------------------+
| IncSz | The storage increment size. |
+------------------+--------------------------------------------------+
| Vol | This value is VOL if storage is volatile. It is |
| | blank if it is nonvolatile. |
+------------------+--------------------------------------------------+
| DynDisp | The dynamic coupling facility dispatch status. |
| | Possible values are: |
| | |
| | YES Dynamic coupling facility dispatching |
| | is active |
| | NO Dynamic coupling facility dispatching |
| | is not active |
| | THIN Dynamic coupling facility dispatching |
| | is not active, but dispatching based |
| | on coupling thin interrupt processing |
| | is enabled for the coupling facility |
| | |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Cache | Invokes CFCACHE for the selected coupling facility. |
+----------+----------------------------------------------------------+
| COnfig | Invokes CFCONFIG for the selected coupling facility. |
+----------+----------------------------------------------------------+
| List | Invokes CFLIST for the selected coupling facility. |
+----------+----------------------------------------------------------+
| Path | Invokes CFPATH for the selected coupling facility. |
+----------+----------------------------------------------------------+
| PRoc | Invokes CFPROC for the selected coupling facility. |
+----------+----------------------------------------------------------+
| Struct | Invokes CFSTRUCT for the selected coupling facility. |
+----------+----------------------------------------------------------+
| User | Invokes CFUSER for the selected coupling facility. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
CFILEREQ

CFILEREQ Command

The CFILEREQ command displays request information for files,


transactions, and programs since the start of the SYSVIEW for
CICS data collector. This command can be used to view file I/O
response times.

The following CICS configuration options must be set on the


CCONFIG command for this data to be collected:

Option Value
-------------------------- ----------------
TRANSACTION-DATA Yes
TRANSACTION-DATA-FILES DETAIL | SUMMARY

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CFILEREQ | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
| | [ All | File | Tran | Program ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
| All | Display all information. |
+------------------+--------------------------------------------------+
| File | Display only the information summarized at the |
| | file level. |
+------------------+--------------------------------------------------+
| Tran | Display only the information summarized at the |
| | file and transaction level. |
+------------------+--------------------------------------------------+
| Program | Display only the information summarized at the |
| | file, transaction and program level. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Filename,A,Tran,A,Program,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Filename | The CICS filename |
+------------------+--------------------------------------------------+
| Tran | The CICS transaction that accessed the file. |
| | * - indicates all transactions |
+------------------+--------------------------------------------------+
| Program | The CICS program that accessed the file. |
| | * - indicates all programs |
+------------------+--------------------------------------------------+
| Reqs | The number of file requests. |
+------------------+--------------------------------------------------+
| Average | The average request time in seconds. |
+------------------+--------------------------------------------------+
| Maximum | The maximum request time in seconds. |
+------------------+--------------------------------------------------+
| Total | The total request time in seconds. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CFILES

CFILES Command

The CFILES command displays CICS File Control Table definitions and
statistics since the last CICS statistics reset.

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CFILEs | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Filename,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Filename | The name of the file defined to CICS. |
+------------------+--------------------------------------------------+
| Type | The file type. |
| | Possible values are: |
| | |
| | RMTE Remote file |
| | KSDS VSAM KSDS |
| | ESDS VSAM ESDS |
| | RRDS VSAM RRDS |
| | VSAM VSAM (specific type not known) |
| | BDAM BDAM |
+------------------+--------------------------------------------------+
| Status | The file status. |
| | Possible values are: |
| | |
| | OPEN |
| | CLOSED |
+------------------+--------------------------------------------------+
| Enabled | The file enabled or disabled status. |
| | Possible values are: |
| | |
| | ENABLED - The file is enabled |
| | DISABLED - The file is disabled |
| | UNENABLE - The file is unenabled |
+------------------+--------------------------------------------------+
| LSR | The Local Resource pool number. |
| | If the file is not assigned to an LSR pool then |
| | this field is blank. |
+------------------+--------------------------------------------------+
| Reqs | The total number of file requests. |
+------------------+--------------------------------------------------+
| EXCPs | The total number of EXCP requests. |
+------------------+--------------------------------------------------+
| Add | The file capabilities. |
| | Possible values are: |
| | |
| | ADD Add requests are supported |
| | blank Add requests are NOT supported |
+------------------+--------------------------------------------------+
| Bro | The file capabilities. |
| | Possible values are: |
| | |
| | BRO Browse requests are supported |
| | blank Browse requests are NOT supported |
+------------------+--------------------------------------------------+
| Del | The file capabilities. |
| | Possible values are: |
| | |
| | DEL Delete requests are supported |
| | blank Delete requests are NOT supported |
+------------------+--------------------------------------------------+
| Read | The file capabilities. |
| | Possible values are: |
| | |
| | READ Read requests are supported |
| | blank Read requests are NOT supported |
+------------------+--------------------------------------------------+
| Upd | The file capabilities. |
| | Possible values are: |
| | |
| | UPD Update requests are supported |
| | blank Update requests are NOT supported |
+------------------+--------------------------------------------------+
| Remote | The remote file name. |
+------------------+--------------------------------------------------+
| SysID | The SysID of the remote file. |
+------------------+--------------------------------------------------+
| Adds | The number of add requests. |
+------------------+--------------------------------------------------+
| Browse | The number of browse requests. |
+------------------+--------------------------------------------------+
| Delete | The number of delete requests. |
+------------------+--------------------------------------------------+
| Reads | The number of read requests. |
+------------------+--------------------------------------------------+
| ReadUpd | The number of read for update requests. |
+------------------+--------------------------------------------------+
| Update | The number of update requests. |
+------------------+--------------------------------------------------+
| CStrW | The current number of string waits. |
+------------------+--------------------------------------------------+
| TStrW | The total number of string waits. |
+------------------+--------------------------------------------------+
| CBufW | The current number of buffer waits. |
+------------------+--------------------------------------------------+
| TBufW | The total number of buffer waits. |
+------------------+--------------------------------------------------+
| DataTbl | The file has been defined as a data table. |
| | Possible values are: |
| | |
| | blank File is not a data table |
| | CICS File is a CICS managed data table |
| | USER File is a user managed data table |
| | CF File is a Coupling Facility data table |
| | RMTE File is a remote data table |
+------------------+--------------------------------------------------+
| RLS | The Record Level Sharing option. |
| | Possible values are: |
| | |
| | RLS Record Level Sharing is supported |
| | blank Record Level Sharing is NOT supported |
+------------------+--------------------------------------------------+
| DFHFCTDS | The address of the File Control Table entry. |
+------------------+--------------------------------------------------+
| Volser | The volser of the data set, if available. |
+------------------+--------------------------------------------------+
| Dataset-Name | The data set name, if available. |
+------------------+--------------------------------------------------+
| DefGroup | The name of the definition group from where |
| | the entry was installed. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Close | Issues a close request for the selected file. |
+------------------+--------------------------------------------------+
| DISable | Issues a disable request for the selected file. |
+------------------+--------------------------------------------------+
| ENAble | Issues an enable request for the selected file. |
+------------------+--------------------------------------------------+
| Open | Issue an open request for the selected file. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| ENQueue | Invokes the ENQUEUES command. Selection is |
| | performed as follows: |
| | |
| | SELECT RNAME EQ dataset.name= |
+------------------+--------------------------------------------------+
| LC | Invokes the IDCAMS LISTCAT command for the |
| | selected data set. |
+------------------+--------------------------------------------------+
| Select | A detailed display of the FCT entry. |
+------------------+--------------------------------------------------+
| Use | Invokes the CFILEUSE command selecting the |
| | filename to show the transactions that are |
| | currently using the file. |
+------------------+--------------------------------------------------+
| VToc | Invokes the VTOC command for the selected |
| | data set. |
+------------------+--------------------------------------------------+
| XTents | Invokes the EXTENTS command for the selected |
| | data set. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CFILES command security


CFILEUSE

CFILEUSE Command

The CFILEUSE display provides information and status of CICS files


that are currently in use by transactions.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CFILEUSE | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Filename,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Filename | The name of the file defined to CICS. |
+------------------+--------------------------------------------------+
| Task# | The current task number, if any. |
+------------------+--------------------------------------------------+
| Tran | The current transaction ID, if any. |
+------------------+--------------------------------------------------+
| NoClose | The file cannot currently be closed. |
+------------------+--------------------------------------------------+
| Add | The number of add requests. |
+------------------+--------------------------------------------------+
| Browse | The number of browse requests. |
+------------------+--------------------------------------------------+
| BrwsUpd | The number of browse for update requests. |
+------------------+--------------------------------------------------+
| Read | The number of read requests. |
+------------------+--------------------------------------------------+
| GetUpd | The number of get for update requests. |
+------------------+--------------------------------------------------+
| Update | The number of update requests. |
+------------------+--------------------------------------------------+
| Delete | The number of delete requests. |
+------------------+--------------------------------------------------+
| SysID | The SysID of the remote file. |
+------------------+--------------------------------------------------+
| Remote | The remote file name. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CFLIST

CFLIST Command

The CFLIST command displays coupling facility summary


information.

Command Syntax

+---------------+-----------------------------------------------------+
| CFLIST | |
+---------------+-----------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Sysplex Name | The name of the sysplex. |
+------------------+--------------------------------------------------+
| Configuration | The sysplex configuration. |
+------------------+--------------------------------------------------+
| Policy | The active CFRM policy name. |
+------------------+--------------------------------------------------+
| Start | The date and time the CFRM policy was activated. |
+------------------+--------------------------------------------------+
| Update | The date and time the CFRM policy was last |
| | updated. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| CFName | The coupling facility name. |
+------------------+--------------------------------------------------+
| CFStat | The coupling facility status. Valid values are: |
| | |
| | ACTIVE The coupling facility is active |
| | DELETE Policy change pending that deletes |
| | this coupling facility from the |
| | CFRM active policy when all |
| | allocated structures are gone |
| | RECONCIL A coupling facility to CFRM policy |
| | reconcile is in progress |
| | FAILED The coupling facility has failed |
| | |
+------------------+--------------------------------------------------+
| SysCt | The number of systems connected. |
+------------------+--------------------------------------------------+
| StrCt | The number of structures allocated. |
+------------------+--------------------------------------------------+
| TotSz | The total storage size. |
+------------------+--------------------------------------------------+
| TotU | The percent of total size that is in use. |
+------------------+--------------------------------------------------+
| StrAv | The amount of storage available for allocating |
| | structures. |
+------------------+--------------------------------------------------+
| StrU | The percent of the StrAv value that is in use. |
+------------------+--------------------------------------------------+
| DmpAv | The amount of storage available for dumping |
| | structures. |
+------------------+--------------------------------------------------+
| DmpU | The percent of the DmpAv value that is in use. |
+------------------+--------------------------------------------------+
| DmpCt | The number of structures currently being dumped. |
+------------------+--------------------------------------------------+
| DmpMx | The maximum amount of storage ever requested to |
| | dump a structure. |
+------------------+--------------------------------------------------+
| StrEx | The number of structures in this facility that |
| | cannot be added to the policy. |
+------------------+--------------------------------------------------+
| RqStr | The required number of structures. A nonzero |
| | value indicates that the policy is not formatted |
| | to contain the maximum number of structure |
| | records and is not large enough to contain all |
| | of the structures that exist in facilities |
| | represented in the policy. The value should be |
| | used as input to format a couple data set for |
| | TYPE CFRM. |
+------------------+--------------------------------------------------+
| RqCon | The required number of connections. A nonzero |
| | value indicates that the policy is not large |
| | enough to contain all the connections that exist |
| | for the structures represented in the policy. |
| | The value should be used as input to format a |
| | couple data set for TYPE CFRM. |
+------------------+--------------------------------------------------+
| ExStr | The number of extra structures. A nonzero value |
| | indicates that the policy is formatted with the |
| | maximum number of structure records (or a |
| | recommendation was made to do so, if nonzero |
| | RqStr field) and represents the number of |
| | structures that must be removed from the policy |
| | to contain all the structures that exist in |
| | coupling facilities represented in the policy. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Cache | Invokes CFCACHE for the selected coupling facility. |
+----------+----------------------------------------------------------+
| COnfig | Invokes CFCONFIG for the selected coupling facility. |
+----------+----------------------------------------------------------+
| List | Invokes CFLIST for the selected coupling facility. |
+----------+----------------------------------------------------------+
| Path | Invokes CFPATH for the selected coupling facility. |
+----------+----------------------------------------------------------+
| PRoc | Invokes CFPROC for the selected coupling facility. |
+----------+----------------------------------------------------------+
| Struct | Invokes CFSTRUCT for the selected coupling facility. |
+----------+----------------------------------------------------------+
| User | Invokes CFUSER for the selected coupling facility. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
CFPATH

CFPATH Command

The CFPATH command displays coupling facility I/O


path information.

Command Syntax

+---------------+-----------------------------------------------------+
| CFPATH | |
+---------------+-----------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Sysplex Name | The name of the sysplex. |
+------------------+--------------------------------------------------+
| Configuration | The sysplex configuration. |
+------------------+--------------------------------------------------+
| Interval | The performance monitoring interval in seconds. |
| | This value is the time between the last two |
| | screen refreshes, or two seconds, whichever is |
| | larger. |
+------------------+--------------------------------------------------+
| Policy | The active CFRM policy name. |
+------------------+--------------------------------------------------+
| Start | The date and time the CFRM policy was activated. |
+------------------+--------------------------------------------------+
| Update | The date and time the CFRM policy was last |
| | updated. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| CFName | The coupling facility name. |
+------------------+--------------------------------------------------+
| CFStat | The coupling facility status. Valid values are: |
| | |
| | ACTIVE The coupling facility is active |
| | DELETE Policy change pending that deletes |
| | this coupling facility from the |
| | CFRM active policy when all |
| | allocated structures are gone |
| | RECONCIL A coupling facility to CFRM policy |
| | reconcile is in progress |
| | FAILED The coupling facility has failed. |
| | |
+------------------+--------------------------------------------------+
| Ctlu | The control unit identifier. |
+------------------+--------------------------------------------------+
| Devn | The device number. |
+------------------+--------------------------------------------------+
| Schn | The subchannel number. |
+------------------+--------------------------------------------------+
| SchStat | The subchannel status. Valid values are: |
| | |
| | ACTIVE Active and in use |
| | NOT_USED Active but not in use |
| | NOT_OPER Not operational |
| | |
+------------------+--------------------------------------------------+
| IORt | The I/O rate in I/Os per second. |
+------------------+--------------------------------------------------+
| IOCt | The I/O count. |
+------------------+--------------------------------------------------+
| SchBs | The subchannel busy count. |
+------------------+--------------------------------------------------+
| PthBs | The all paths busy termination count. |
+------------------+--------------------------------------------------+
| ChP | The channel path identifier. |
+------------------+--------------------------------------------------+
| Vld | This value is VLD if the path has been |
| | validated. If not, it is blank. |
+------------------+--------------------------------------------------+
| Phy | This value is PHY if the path is physically |
| | online. If not, it is blank. |
+------------------+--------------------------------------------------+
| Log | This value is LOG if the path is logically |
| | online. If not, it is blank. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Cache | Invokes CFCACHE for the selected coupling facility. |
+----------+----------------------------------------------------------+
| COnfig | Invokes CFCONFIG for the selected coupling facility. |
+----------+----------------------------------------------------------+
| List | Invokes CFLIST for the selected coupling facility. |
+----------+----------------------------------------------------------+
| Path | Invokes CFPATH for the selected coupling facility. |
+----------+----------------------------------------------------------+
| PRoc | Invokes CFPROC for the selected coupling facility. |
+----------+----------------------------------------------------------+
| Struct | Invokes CFSTRUCT for the selected coupling facility. |
+----------+----------------------------------------------------------+
| User | Invokes CFUSER for the selected coupling facility. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
CFPROC

CFPROC Command

The CFPROC command displays coupling facility processor


utilization.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+---------------+-----------------------------------------------------+
| CFPROC | |
+---------------+-----------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Sysplex Name | The name of the sysplex. |
+------------------+--------------------------------------------------+
| Configuration | The sysplex configuration. |
| | When XSDATA is YES this value is displayed in |
| | the data rows as field "PlexMode". |
+------------------+--------------------------------------------------+
| Interval | The performance monitoring interval in seconds. |
| | This value is the time between the last two |
| | screen refreshes, or two seconds, whichever is |
| | larger. |
| | When XSDATA is YES this value is displayed in |
| | the data rows as field "Intvl". |
+------------------+--------------------------------------------------+
| Policy | The active CFRM policy name. |
| | When XSDATA is YES this value is displayed in |
| | the data rows as field "Policy". |
+------------------+--------------------------------------------------+
| Start | The date and time the CFRM policy was activated. |
+------------------+--------------------------------------------------+
| Update | The date and time the CFRM policy was last |
| | updated. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| CFName | The coupling facility name. |
+------------------+--------------------------------------------------+
| CFStat | The coupling facility status. Valid values are: |
| | |
| | ACTIVE The coupling facility is active |
| | DELETE Policy change pending that deletes |
| | this coupling facility from the |
| | CFRM active policy when all |
| | allocated structures are gone |
| | RECONCIL A coupling facility to CFRM policy |
| | reconcile is in progress |
| | FAILED The coupling facility has failed |
| | |
+------------------+--------------------------------------------------+
| Addr | The processor address or ALL for processor |
| | summary. |
+------------------+--------------------------------------------------+
| Busy% | The processor busy percentage. |
+------------------+--------------------------------------------------+
| BusyGraph | The processor busy percentage bar graph. |
+------------------+--------------------------------------------------+
| PWt | Current processor weight. This is a number from |
| | 0 to 999 if the processor is shared or "DED" if |
| | the processor is dedicated. This field will be |
| | "n/a" if the CF level is not 15 or higher and it |
| | will blank on the "ALL" line. |
+------------------+--------------------------------------------------+
| The following fields are only displayed when XSDATA is YES. |
+------------------+--------------------------------------------------+
| Policy | The active CFRM policy name. |
| | When XSDATA is NO this value is displayed in |
| | the information section as "Policy" |
+------------------+--------------------------------------------------+
| PlexMode | The sysplex configuration. |
| | When XSDATA is NO this value is displayed in |
| | the information section as "Configuration" |
+------------------+--------------------------------------------------+
| Intvl | The performance monitoring interval in seconds. |
| | This value is the time between the last two |
| | screen refreshes, or two seconds, whichever is |
| | larger. |
| | When XSDATA is NO this value is displayed in |
| | the information section as "Interval" |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Cache | Invokes CFCACHE for the selected coupling facility. |
+----------+----------------------------------------------------------+
| COnfig | Invokes CFCONFIG for the selected coupling facility. |
+----------+----------------------------------------------------------+
| List | Invokes CFLIST for the selected coupling facility. |
+----------+----------------------------------------------------------+
| Path | Invokes CFPATH for the selected coupling facility. |
+----------+----------------------------------------------------------+
| PRoc | Invokes CFPROC for the selected coupling facility. |
+----------+----------------------------------------------------------+
| Struct | Invokes CFSTRUCT for the selected coupling facility. |
+----------+----------------------------------------------------------+
| User | Invokes CFUSER for the selected coupling facility. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
| OPTIONS | Set and display CFPROC options. |
+----------+----------------------------------------------------------+

OPTIONS Subcommand

The OPTIONS subcommand is used to set and display CFPROC command


processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [cfpopts] |
+---------------+-----------------------------------------------------+

The following table lists and explains the valid


OPTIONS parameter values. Any number of the values
can be specified in any order. The current settings
of all options are always displayed in response to
the OPTIONS subcommand.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| NOAll | Controls whether or not the ALL processors total |
| All | line will be displayed. The default is ALL. |
+---------------+-----------------------------------------------------+
| RESET | Resets all options to their initial default values. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_CFPROC. This keyword is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. The EXTRACT keyword can be |
| | specified alone or in combination with any other |
| | OPTIONS keyword. |
+---------------+-----------------------------------------------------+
CFSTRUCT

CFSTRUCT Command

The CFSTRUCT command displays information about


structures allocated in coupling facilities.

Command Syntax

+---------------+-----------------------------------------------------+
| CFSTRUCT | |
+---------------+-----------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Sysplex Name | The name of the sysplex. |
+------------------+--------------------------------------------------+
| Configuration | The sysplex configuration. |
+------------------+--------------------------------------------------+
| Interval | The performance monitoring interval in seconds. |
| | This value is the time between the last two |
| | screen refreshes, or two seconds, whichever is |
| | larger. |
+------------------+--------------------------------------------------+
| Policy | The active CFRM policy name. |
+------------------+--------------------------------------------------+
| Start | The date and time the CFRM policy was activated. |
+------------------+--------------------------------------------------+
| Update | The date and time the CFRM policy was last |
| | updated. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| CFName | The coupling facility name. This field will |
| | contain "n/a" for structures with a status of |
| | UNALLOC. |
+------------------+--------------------------------------------------+
| CFStat | The coupling facility status. Valid values are: |
| | |
| | ACTIVE The coupling facility is active |
| | DELETE Policy change pending that deletes |
| | this coupling facility from the |
| | CFRM active policy when all |
| | allocated structures are gone |
| | RECONC A coupling facility to CFRM policy |
| | reconcile is in progress |
| | FAILED The coupling facility has failed |
| | n/a This value displays when the |
| | CFName is "n/a" which occurs only |
| | when the structure status is |
| | UNALLOC. |
| | |
+------------------+--------------------------------------------------+
| StrName | The structure name. |
+------------------+--------------------------------------------------+
| StrStat | The structure status. Valid values are: |
| | |
| | ALLOC Allocated, active, and in use. |
| | |
| | NOSYSCON No systems have connectivity. |
| | |
| | FAILED Structure has failed. |
| | |
| | RBLD_OLD Structure rebuild is in progress |
| | and this is the old structure. |
| | |
| | RBLD_NEW Structure rebuild is in progress |
| | and this is the new structure. |
| | |
| | TRANSIT Status is in transition. |
| | |
| | HOLDING Structure is in holding state. |
| | |
| | DUMPING Structure is being dumped. |
| | |
| | UNALLOC Structure is not allocated. |
| | The CFName and CFStat will |
| | display "n/a". |
| | |
+------------------+--------------------------------------------------+
| StrDisp | The structure disposition. Valid values are: |
| | |
| | DELETE The structure is deleted after |
| | all connectors have disconnected |
| | from the structure |
| | |
| | KEEP The structure remains allocated |
| | after all connectors have |
| | disconnected from the structure |
| | |
+------------------+--------------------------------------------------+
| StrTp | The structure type. Valid values are: |
| | |
| | CACHE Cached data structure |
| | LIST Data list structure |
| | LOCK Serialization structure |
| | SLIST Serialized data structure |
| | UNKWN The type could not be determined |
+------------------+--------------------------------------------------+
| StrEncr | The structure encryption setting. Valid values |
| | are: |
| | |
| | STRENCR The structure is encrypted |
| | |
+------------------+--------------------------------------------------+
| DupStat | The duplex status. Values can be |
| | |
| | DISABLED The CFRM administrative policy |
| | specifies or defaults to |
| | DUPLEX(DISABLE) for this |
| | structure. |
| | |
| | ALLOWED The CFRM administrative policy |
| | specifies DUPLEX(ALLOW) for |
| | this structure. |
| | |
| | ENABLED The CFRM administrative policy |
| | specifies DUPLEX(ENABLE) for |
| | this structure. |
| | |
| | ACTIVE The CFRM administrative policy |
| | specifies either DUPLEX(ALLOW) |
| | or DUPLEX(ENABLE) and duplexing |
| | has been successfully established. |
| | |
+------------------+--------------------------------------------------+
| DupType | The duplex lock type. Values can be |
| | |
| | SYNCH The duplex lock is synchronous |
| | |
| | PRIASYNC The duplex lock is asynchronous |
| | primary structure |
| | |
| | SECASYNC The duplex lock is asynchronous |
| | secondary structure |
| | |
| | INACTIVE The duplex is enabled or allowed |
| | but not active |
| | |
+------------------+--------------------------------------------------+
| IORt | The I/O rate as a number per second. |
+------------------+--------------------------------------------------+
| IOCt | The total I/O count. |
+------------------+--------------------------------------------------+
| ReqRt | The user request rate as a number per second. |
+------------------+--------------------------------------------------+
| ReqCt | The total user request count. |
+------------------+--------------------------------------------------+
| CPUTime | Total structure-related CPU execution time. |
+------------------+--------------------------------------------------+
| CPUDelta | Structure-related CPU execution time in the |
| | current interval. |
+------------------+--------------------------------------------------+
| CPU% | Structure-related CPU execution time percentage |
| | of the current interval. |
+------------------+--------------------------------------------------+
| SynCt | The synchronous I/O count. |
+------------------+--------------------------------------------------+
| AsyCt | The asynchronous I/O count. |
+------------------+--------------------------------------------------+
| SynAv | The synchronous I/O average service time |
| | (microseconds). |
+------------------+--------------------------------------------------+
| AsyAv | The asynchronous I/O average service time |
| | (microseconds). |
+------------------+--------------------------------------------------+
| CnvCt | The synchronous operations converted to |
| | asynchronous. |
+------------------+--------------------------------------------------+
| QueCt | I/O requests queued for subchannel contention. |
+------------------+--------------------------------------------------+
| CurSz | The current structure size. |
+------------------+--------------------------------------------------+
| MaxSz | The maximum structure size. |
+------------------+--------------------------------------------------+
| MinSz | The minimum structure size. |
+------------------+--------------------------------------------------+
| IntSz | The initial structure size. |
+------------------+--------------------------------------------------+
| MrgSz | The marginal structure size. (CFLEVEL1) |
+------------------+--------------------------------------------------+
| TgtSz | The target structure size. (CFLEVEL1) |
+------------------+--------------------------------------------------+
| DmpSz | The structure dump table size. |
+------------------+--------------------------------------------------+
| ElmTg | The target maximum element count. (CFLEVEL1) |
+------------------+--------------------------------------------------+
| EntTg | The target maximum entry count. (CFLEVEL1) |
+------------------+--------------------------------------------------+
| RType | The ratio type. Valid values are: |
| | |
| | EN/EL Entry-to-element (LIST and LOCK) |
| | |
| | EL/EN Element-to-entry (LIST and LOCK) |
| | |
| | DR/EL Directory-to-element (CACHE) |
| | |
| | EL/DR Element-to-directory (CACHE) |
| | |
| | NO_EL No elements |
| | |
+------------------+--------------------------------------------------+
| Ratio | The ratio of the above type. |
+------------------+--------------------------------------------------+
| Attrib | The structure attributes. Valid values are: |
| | |
| | A..... Adjunct |
| | .C.... Count (limit accounting by element) |
| | ..D... Data |
| | ...K.. Key |
| | ....L. Lock |
| | .....N Name |
| | |
+------------------+--------------------------------------------------+
| The following fields are valid only for types LIST and LOCK: |
+------------------+--------------------------------------------------+
| LstSz | The list size. The list element size. |
+------------------+--------------------------------------------------+
| LstCt | The list count. |
+------------------+--------------------------------------------------+
| LstMx | The list maximum. The maximum number of list |
| | elements per entry. |
+------------------+--------------------------------------------------+
| ElmMx | The element maximum. |
+------------------+--------------------------------------------------+
| ElmUs | The elements used. |
+------------------+--------------------------------------------------+
| EntMx | The entry maximum. |
+------------------+--------------------------------------------------+
| EntUs | The entries used. |
+------------------+--------------------------------------------------+
| LckSz | The lock size. The lock table entry size. |
+------------------+--------------------------------------------------+
| LckCt | The lock count. The lock table entry count. |
+------------------+--------------------------------------------------+
| LNzCt | The lock nonzero count. The nonzero lock table |
| | entry count. |
+------------------+--------------------------------------------------+
| The following fields are valid only for type CACHE: |
+------------------+--------------------------------------------------+
| DirCt | The directory entry count. |
+------------------+--------------------------------------------------+
| DatCt | The data element count. |
+------------------+--------------------------------------------------+
| DatSz | The data element size. |
+------------------+--------------------------------------------------+
| DatMx | The data element maximum. The maximum number of |
| | data elements per directory entry. |
+------------------+--------------------------------------------------+
| DirCh | The directory entry changed count. |
+------------------+--------------------------------------------------+
| DatCh | The data element changed count. |
+------------------+--------------------------------------------------+
| StCMx | The storage class maximum. |
+------------------+--------------------------------------------------+
| CoCMx | The cast out class maximum. |
+------------------+--------------------------------------------------+
| The remaining fields are not type-specific: |
+------------------+--------------------------------------------------+
| UsrMx | The maximum number of user connections allowed. |
+------------------+--------------------------------------------------+
| UsrCt | The current number of users connected. |
+------------------+--------------------------------------------------+
| AlcDate | The date of structure allocation. |
+------------------+--------------------------------------------------+
| AlcTime | The time of structure allocation. |
+------------------+--------------------------------------------------+
| AccLimit | The length of time, expressed in seconds, a |
| | structure accessor can tolerate not having |
| | access to the structure or NO_LIMIT if there is |
| | no time limit. |
|------------------+--------------------------------------------------+
| StrId | The structure identifier. |
+------------------+--------------------------------------------------+
| StrVers | The structure version. |
+------------------+--------------------------------------------------+
| DmpId | The dump identifier. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands


+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Cache | Invokes CFCACHE for the selected structure. |
+----------+----------------------------------------------------------+
| COnfig | Invokes CFCONFIG for the selected coupling facility. |
+----------+----------------------------------------------------------+
| DStruct | Invokes the XMVS command D XCF,STR,STRNAME=strname to |
| | display the structure information. |
+----------+----------------------------------------------------------+
| List | Invokes CFLIST for the selected coupling facility. |
+----------+----------------------------------------------------------+
| Path | Invokes CFPATH for the selected coupling facility. |
+----------+----------------------------------------------------------+
| PRoc | Invokes CFPROC for the selected coupling facility. |
+----------+----------------------------------------------------------+
| Struct | Invokes CFSTRUCT for the selected structure. |
+----------+----------------------------------------------------------+
| User | Invokes CFUSER for the selected structure. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
| OPTIONS | Set and display CFSTRUCT options. |
+----------+----------------------------------------------------------+

OPTIONS Subcommand

The OPTIONS subcommand is used to set and display


CFSTRUCT command processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [cfstopts] |
+---------------+-----------------------------------------------------+

The following table lists and explains the valid


OPTIONS parameter values. Any number of the values
can be specified in any order. The current settings
of all options are always displayed in response to
the OPTIONS subcommand.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| NOUnalloc | Controls whether or not unallocated structures will |
| Unalloc | be displayed. The default is UNALLOC. |
+---------------+-----------------------------------------------------+
| RESET | Resets all options to their initial default values. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_CFSTRUCT. This keyword is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. The EXTRACT keyword can be |
| | specified alone or in combination with any other |
| | OPTIONS keyword. |
+---------------+-----------------------------------------------------+
CFUSER

CFUSER Command

The CFUSER command displays information about the


user connections to structures allocated in coupling
facilities.

Command Syntax

+---------------+-----------------------------------------------------+
| CFUSER | |
+---------------+-----------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Sysplex Name | The name of the sysplex. |
+------------------+--------------------------------------------------+
| Configuration | The sysplex configuration. |
+------------------+--------------------------------------------------+
| Policy | The active CFRM policy name. |
+------------------+--------------------------------------------------+
| Start | The date and time the CFRM policy was activated. |
+------------------+--------------------------------------------------+
| Update | The date and time the CFRM policy was last |
| | updated. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| CFName | The coupling facility name. |
+------------------+--------------------------------------------------+
| CFStat | The coupling facility status. Valid values are: |
| | |
| | ACTIVE The coupling facility is active. |
| | |
| | DELETE Policy change pending that deletes |
| | this coupling facility from the |
| | CFRM active policy when all |
| | allocated structures are gone. |
| | |
| | RECONCIL A coupling facility to CFRM policy |
| | reconcile is in progress. |
| | |
| | FAILED The coupling facility has failed. |
| | |
+------------------+--------------------------------------------------+
| StrName | The structure name. |
+------------------+--------------------------------------------------+
| StrStat | The structure status. Valid values are: |
| | |
| | ALLOC Allocated, active, and in use. |
| | |
| | CHANGE Change pending in CFRM policy. |
| | |
| | REBUILD Structure rebuild in progress. |
| | |
| | REB_STOP Structure rebuild stopped. |
| | |
| | ALTER Structure alter in progress. |
| | |
+------------------+--------------------------------------------------+
| StrDisp | The structure disposition. |
+------------------+--------------------------------------------------+
| SysName | The system name of the user connection. |
+------------------+--------------------------------------------------+
| JobName | The job name of the user connection. |
+------------------+--------------------------------------------------+
| ConName | The connection name. |
+------------------+--------------------------------------------------+
| ConStat | The connection status. Valid values are: |
| | |
| | ACTIVE Active, connection established. |
| | |
| | DUAL Rebuild in progress and connected |
| | to both new and old structures. |
| | |
| | DISCONCT Disconnection in progress. |
| | |
| | FAILED Failed persistent state. |
| | |
| | FAILING Failure in progress. |
| | |
+------------------+--------------------------------------------------+
| ConDisp | The disposition of the connection after the |
| | requestor abnormally terminates or disconnects |
| | with a failure reason code. Valid values are: |
| | |
| | KEEP The connection is to be placed in |
| | a failed-persistent state. |
| | |
| | DELETE The connection is to be placed in |
| | a not-defined state. |
| | |
+------------------+--------------------------------------------------+
| ReBld | The value is REBLD if the connection allows |
| | structure rebuild. |
+------------------+--------------------------------------------------+
| Alter | The value is ALTER if the connection allows |
| | structure alter. |
+------------------+--------------------------------------------------+
| ConVers | The connection version. |
+------------------+--------------------------------------------------+
| ConId | The connection identifier. |
+------------------+--------------------------------------------------+
| ASID | The ASID of the user connection. |
+------------------+--------------------------------------------------+
| ConData | The user connection exit data. |
+------------------+--------------------------------------------------+
| DisconData | The user disconnection exit data. |
+------------------+--------------------------------------------------+
| ConToken | The connection token. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Cache | Invokes CFCACHE for the selected structure. |
+----------+----------------------------------------------------------+
| COnfig | Invokes CFCONFIG for the selected coupling facility. |
+----------+----------------------------------------------------------+
| List | Invokes CFLIST for the selected coupling facility. |
+----------+----------------------------------------------------------+
| Path | Invokes CFPATH for the selected coupling facility. |
+----------+----------------------------------------------------------+
| PRoc | Invokes CFPROC for the selected coupling facility. |
+----------+----------------------------------------------------------+
| Struct | Invokes CFSTRUCT for the selected structure. |
+----------+----------------------------------------------------------+
| User | Invokes CFUSER for the selected structure. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
CGATES

CGATES Command

The CGATES command displays defined gate information for CICS


domains.

Command Syntax

+------------------+--------------------------------------------------+
| CGATES | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: Num,A,Gate,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Domain | The name of the domain. |
+------------------+--------------------------------------------------+
| Num | The number assigned to the domain by CICS. |
+------------------+--------------------------------------------------+
| Gate | The gate number. |
+------------------+--------------------------------------------------+
| GateMod | The module name for the gate. |
+------------------+--------------------------------------------------+
| Mode | The stack mode index. |
+------------------+--------------------------------------------------+
| Size | The actual stack size. |
+------------------+--------------------------------------------------+
| Prolog | The address of the gate module prolog. |
+------------------+--------------------------------------------------+
| EPAddr | The entry point address of routine address for |
| | gate. |
+------------------+--------------------------------------------------+
| Module | The module name that the EPAddr points to, |
| | if it is available. |
+------------------+--------------------------------------------------+
| Offset | The offset into the module. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DOMAIN | Invokes the CDOMAINS command positioning to the |
| | selected domain. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CGBLEXIT

CGBLEXIT Command

The CGBLEXIT command displays the list of CICS global user exits
that are available. The user exits are displayed in the order in
which they are executed.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CGBLEXIT | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+
| Requests | The total number of global user exits calls that |
| | have been processed by SYSVIEW. |
+------------------+--------------------------------------------------+
| ReqTime | The average time spent processing a request. |
+------------------+--------------------------------------------------+
| TRegTime | The total time spent processing all requests. |
+------------------+--------------------------------------------------+
| CPUTime | The average CPU time used to process a request. |
+------------------+--------------------------------------------------+
| TCPUTime | The total CPU time used to process all requests. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Num,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Exitname | The name of the CICS global user exit. |
| | Global User Exit Descriptions |
+------------------+--------------------------------------------------+
| Num | The number assigned to the exit. |
+------------------+--------------------------------------------------+
| Program | The enabled global user exit program name that |
| | is attached to the exit. |
+------------------+--------------------------------------------------+
| Module | The enabled global user exit module name. |
+------------------+--------------------------------------------------+
| Address | The address of the module. |
+------------------+--------------------------------------------------+
| Gbl-Addr | The address of the global work area assigned to |
| | the user exit. |
+------------------+--------------------------------------------------+
| GblLen | The length of the global area, in bytes. |
+------------------+--------------------------------------------------+
| Requests | The total number of requests that have been |
| | processed by SYSVIEW. |
+------------------+--------------------------------------------------+
| Req% | The percentage of total requests. |
+------------------+--------------------------------------------------+
| ReqTime | The average time spent processing a request. |
+------------------+--------------------------------------------------+
| TReqTime | The total time spent processing all requests. |
+------------------+--------------------------------------------------+
| ReqT% | The percentage of total request time. |
+------------------+--------------------------------------------------+
| CPUTime | The average CPU time used to process a request. |
+------------------+--------------------------------------------------+
| TCPUTime | The total CPU time used to process all requests. |
+------------------+--------------------------------------------------+
| CPUT% | The percentage of total CPU time. |
+------------------+--------------------------------------------------+
| Start | Specifies that the exit program has been |
| | started. |
+------------------+--------------------------------------------------+
| Load | Specifies that the exit program has been loaded. |
| | The program was loaded by a user, and should not |
| | be deleted when disabled. |
+------------------+--------------------------------------------------+
| Dis | Specifies that the exit program has been |
| | disabled. |
+------------------+--------------------------------------------------+
| DRC | The Default Return Code value. A blank |
| | indicates a return code of zero. |
+------------------+--------------------------------------------------+
| MRC | The Maximum Return Code value. A blank |
| | indicates a return code of zero. |
+------------------+--------------------------------------------------+
| GCount | The global area use count. |
+------------------+--------------------------------------------------+
| ACount | The activation count. |
+------------------+--------------------------------------------------+
| ICount | The invocation count. |
+------------------+--------------------------------------------------+
| TCount | The Tie-Count. |
+------------------+--------------------------------------------------+
| LastDate | The last date and time that a request was |
| LastTime | processed. |
+------------------+--------------------------------------------------+
| DFHUETE | The address of the DFHUETE control block. |
+------------------+--------------------------------------------------+
| EPL | The address of the EPL control block. |
+------------------+--------------------------------------------------+
| EPB | The address of the EPB control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.
Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Help | Display help for the selected exitname. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Changes for Release 17.0


-------------------------------------------------------------------------------

Documentation for SYSVIEW can be found at the Tech Docs Portal:

SYSVIEW Performance Management

https://techdocs.broadcom.com/sysview

The content includes:

* Tech Docs Portal Search Tips


* SYSVIEW Product Overview
* Release Notes
* Administering
* Installing
* Messages
* Reporting
* Security
* Using SYSVIEW
* Using GMI
* Machine Learning Capabilities
* Scenarios, How to Articles, Videos and Online Help Topics
* Command Reference
* Additional Resources

+-----------------------------------------------------------------------------+
| Release Dates |
+-----------------------------------------------------------------------------+

Release Build Type GA Date


------- ----- ----------- --------------
17.0 1010 Continuous July 2022
16.0 0990 Continuous April 2019
15.0 0980 Complete December 2018
0980 Incremental May 2017
14.2 0960 Complete November 2016
14.1 0940 Complete September 2015
14.0 0820 Complete June 2014
13.9 0760 Complete September 2013
13.7 0740 Complete December 2012
13.5 0720 Complete May 2012
13.0 0700 Complete April 2011
12.7 0690 Complete April 2010
12.5 0670 Complete September 2009
12.0 0640 Complete September 2008
11.6 0610 Complete June 2007
11.5 0591 Complete March 2006
11.0 0570 Complete November 2004
7.7 0550 Complete August 2003
7.6 0541 Complete August 2002
7.5 0535 Complete March 2002
7.4 n/a Complete November 2000
7.3 n/a Complete August 1999
7.2.3 n/a Complete November 1998
7.2 n/a Complete January 1998
7.1.1 n/a Complete April 1997
7.1 n/a Complete October 1996
6.1 n/a Complete May 1995
5.2 n/a Complete December 1994
CHANPATH

CHANPATH Command

The CHANPATH command displays channel path status.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+---------------+-----------------------------------------------------+
| CHANPATH | |
+---------------+-----------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| CPMF | The Channel Path Measurement Facility status. |
| | Valid values are: |
| | |
| | ACTIVE Active |
| | INACTIVE Inactive |
| | UNAVAIL Unavailable |
+------------------+--------------------------------------------------+
| Interval | The interval, in seconds, used for the busy |
| | percentage calculations. The time between two |
| | consecutive screen refreshes or two seconds, |
| | whichever is larger, is used. |
| | When XSDATA is YES this value is displayed in |
| | the data rows as field "Intvl". |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| ChP | The channel path identifier. |
+------------------+--------------------------------------------------+
| PChId | The physical channel identifier, if available. |
| | If not available, "n/a" will be displayed. |
+------------------+--------------------------------------------------+
| Mgd | The value is MGD if the channel path is managed. |
| | Otherwise, it is blank. |
+------------------+--------------------------------------------------+
| Own | The value is OWN if the channel path is owned. |
| | Otherwise, it is blank. |
+------------------+--------------------------------------------------+
| Shr | The value is SHR if the channel path is shared. |
| | Otherwise, it is blank. |
+------------------+--------------------------------------------------+
| Status | The status of the channel path. |
| | |
| | Values can be: |
| | |
| | ONLINE Online |
| | OFFLINE Offline |
| | ONLIN-P Online but pending offline |
| | |
+------------------+--------------------------------------------------+
| Type | The channel path type. |
| | |
| | Values can be: |
| | |
| | BLK_MPX Block multiplexer |
| | BYT_MPX Byte multiplexer |
| | CF_PEER Coupling facility peer |
| | CF_RECV Coupling facility receiver |
| | CF_SEND Coupling facility sender |
| | CIB Coupling over Infiniband |
| | CS5 Coupling over PCIe |
| | CTC_PTP CTC adapter point-to-point |
| | CTC_SWT CTC adapter switched |
| | CTC_SWT CTC adapter switched point-to-point |
| | CTC_UNK Unknown CTC adapter path type |
| | DSD Direct system device |
| | EIO Emulated I/O |
| | ESC_CNV ESCON path to a block converter |
| | ESC_FBR ESCON fiber extended |
| | ESC_NTV ESCON native |
| | ESC_PAC ESCON byte pacer |
| | ESC_PTP ESCON point-to-point |
| | ESC_SWT ESCON switched |
| | FCP Fibre Channel Protocol CHPID |
| | FICON_BR FICON bridge |
| | FICON_IN FICON (incomplete description) |
| | FICON_NT FICON native |
| | FICON_SW FICON switched |
| | IC_PEER Internal Coupling peer |
| | ICB_PEER Integrated cluster bus peer |
| | ICB_RECV Integrated cluster bus receiver |
| | ICB_SEND Integrated cluster bus sender |
| | IISC_RCV Internal ISC receiver |
| | IISC_SND Internal ISC sender |
| | IQD Internal Queued Direct Communication|
| | ISD Internal System Device |
| | OSA Open systems adapter |
| | OSA_CONS OSA console |
| | OSA_DIRX OSA direct express channel path |
| | OSA_EXPR OSA express channel path |
| | OSA_NCP OSA NCP (OSN) |
| | OSA_ZBXD OSA zBX Data |
| | OSA_ZBXM OSA zBX Management |
| | UNK_xx Unknown where: |
| | xx = type code |
| | UNKNOWN Unknown |
| | |
+------------------+--------------------------------------------------+
| Devct | The count of devices on the channel path. |
+------------------+--------------------------------------------------+
| BusyTime | The channel path busy time for the interval. |
| | This is valid when CMG = "1" or is blank. |
+------------------+--------------------------------------------------+
| Busy | The channel path busy percent over the last |
| | interval. |
+------------------+--------------------------------------------------+
| Busy-Graph | A graphical display of channel path busy |
| | percent. |
+------------------+--------------------------------------------------+
| LparTime | The channel path busy time when the CPC is |
| | operating in LPAR mode. This is valid when |
| | CMG = "1". |
+------------------+--------------------------------------------------+
| Lpar | The LPAR channel path busy percent over the last |
| | interval. This is valid when CMG = "1". |
+------------------+--------------------------------------------------+
| Lpar-Graph | A graphical display of LPAR channel path busy |
| | pct. This is valid when CMG = "1". |
+------------------+--------------------------------------------------+
| Elapsed | The channel path elapsed time interval. |
+------------------+--------------------------------------------------+
| TotBusy | The count of the internal bus cycles used for |
| | I/O operations for the interval. This is valid |
| | when CMG = "2". |
+------------------+--------------------------------------------------+
| MaxBusy | The maximum internal bus cycles per second |
| | available for I/O operations. This is valid |
| | when CMG = "2". |
+------------------+--------------------------------------------------+
| TotChan | The count of channel work units performed for |
| | the interval. This is valid when CMG = "2". |
+------------------+--------------------------------------------------+
| LparChan | the count of channel work units performed for |
| | the logical partition for the interval. This is |
| | valid when CMG = "2". |
+------------------+--------------------------------------------------+
| MaxChan | The maximum channel work units that can be |
| | performed per second by the channel path. This |
| | is valid when CMG = "2". |
+------------------+--------------------------------------------------+
| TotWrite | The count of data units written for the |
| | interval. This is valid when CMG = "2". |
+------------------+--------------------------------------------------+
| LparWrite | The count of data units written for the logical |
| | partition for the interval. This is valid when |
| | CMG = "2". |
+------------------+--------------------------------------------------+
| MaxWrite | The maximum number of data units that can be |
| | written per second by the channel path. This is |
| | valid when CMG = "2" |
+------------------+--------------------------------------------------+
| TotRead | The count of data units read for the interval. |
| | This is valid when CMG = "2". |
+------------------+--------------------------------------------------+
| LparRead | The count of data units read for the logical |
| | partition for the interval. This is valid when |
| | CMG = "2". |
+------------------+--------------------------------------------------+
| MaxRead | The maximum number of data units that can be |
| | read per second by the channel path. This is |
| | valid when CMG = "2". |
+------------------+--------------------------------------------------+
| DataUnit | The number of bytes of data that are contained |
| | in a data unit for the channel path. This is |
| | valid when CMG = "2". |
+------------------+--------------------------------------------------+
| CMG | The channel measurement group. |
+------------------+--------------------------------------------------+
| CMC2 | The address of the Channel Measurement |
| | Characteristics for the extended CPMF data |
| | control block. |
+------------------+--------------------------------------------------+
| CPM2 | The address of the Channel Path Measurement |
| | Block extended (format 2). |
+------------------+--------------------------------------------------+
| CPMB | The address of the Channel Path Measurement |
| | Block. |
+------------------+--------------------------------------------------+
| Intvl | The interval, in seconds, used for the busy |
| | percentage calculations. The time between two |
| | consecutive screen refreshes or two seconds, |
| | whichever is larger, is used. |
| | When XSDATA is YES this value is displayed in |
| | the information section as "Interval" |
+------------------+--------------------------------------------------+
| CPMF | Channel Path Measurement Facility status. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Select | Invokes the DEVPATH command to display the devices on |
| | the channel path. |
+----------+----------------------------------------------------------+
| Plot | Invokes the PLOT command to plot the channel path |
| | busy percentage. |
+----------+----------------------------------------------------------+
| DM | Invokes the XMVS command to display the output of |
| | a "D M=CHP(chp)" operating system command for the |
| | selected channel path identifier. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
CHOSTS

CHOSTS Command

The CHOSTS command displays CICS virtual hosts information.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CHOSTs | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,HostName,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| HostName | The virtual host's name. |
+------------------+--------------------------------------------------+
| Status | The status of the virtual host. |
| | |
| | Possible values are: |
| | ENABLED |
| | DISABLED |
+------------------+--------------------------------------------------+
| TCPIPSvc | The TCPIPSERVICE defintion used by the virtual |
| | host. |
+------------------+--------------------------------------------------+
| IPAddress | The virtual host's IP address. |
+------------------+--------------------------------------------------+
| RefCount | The number of times located. |
+------------------+--------------------------------------------------+
| DRefCount | The number of times found disabled. |
+------------------+--------------------------------------------------+
| Remote | Indicates if the virtual host is remote or not. |
| | This field will be blank for non-remote hosts. |
+------------------+--------------------------------------------------+
| UVH | The address of the URI Virtual Host |
| | control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields


In xsystem data mode, additional data fields are present.
Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| DISable | Disable virtual host. |
+----------+----------------------------------------------------------+
| ENAble | Enable virtual host. |
+----------+----------------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CICE

CICE Command

The CICE command displays the CICS Interval Control Elements (ICE)
chain, which represents time-dependent transaction requests. The
time interval may be specified either as a time of day or an
interval of time. To keep track of the event, CICS creates an ICE
and places it on the ICE chain in time-out sequence.

An ICE can perform the following functions:

1) WAIT - Delays the transaction.


2) POST - Posts the transaction when a specified interval has
elapsed.
3) INITIATE - Starts a transaction.
4) PUT - Starts a transaction and passes data through Temporary
Storage.

Command Syntax

+------------------+--------------------------------------------------+
| CICE | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Tran | The original transaction ID or the transaction |
| | ID that is started when the element expires. |
+------------------+--------------------------------------------------+
| Term | The terminal ID (shown only for ICEs that |
| | require acquisition of a terminal) or address of |
| | the TCA if this ICE request is used to delay an |
| | executing transaction. |
+------------------+--------------------------------------------------+
| Exp-Date | The expiration date for the ICE. |
+------------------+--------------------------------------------------+
| Exp-Time | The expiration time for the ICE. |
+------------------+--------------------------------------------------+
| Address | The address of the ICE control block. |
+------------------+--------------------------------------------------+
| ECB-Addr | The address of the ECB to be posted when the ICE |
| | expires. |
+------------------+--------------------------------------------------+
| Id | The unique internal identification string |
| | assigned to the ICE by either a transaction or |
| | CICS. |
| | |
| | The ID is displayed as an * when the internal ID |
| | is equal to lovalues. |
+------------------+--------------------------------------------------+
| Type | The ICE expiration method. Valid values are: |
| | |
| | WAIT Delays the transaction |
| | POST Posts the transaction when a |
| | specified interval has elapsed |
| | INITIATE Intersystem communication (ISC) |
| | using the 6.1 protocol |
| | LUC ISC using the 6.2 protocol |
+------------------+--------------------------------------------------+
| Status | The status bytes found in the ICE. This field |
| | displays, in hexadecimal, both the ICE type and |
| | status. |
| | |
| | Status byte 1 - TYPE |
| | |
| | The method used to initiate the transaction. |
| | Valid values are: |
| | |
| | X'10' TDP schedule |
| | X'20' WAIT |
| | X'30' POST |
| | X'40' ICP initiate |
| | X'40' SIP schedule |
| | X'50' ICP put data |
| | X'80' BMS schedule |
| | X'08' ISC schedule |
| | X'04' TR/TS remote delete |
| | |
| | Status byte 2 - STATUS |
| | |
| | Valid values are: |
| | |
| | X'01' On chain bit |
| | X'02' This ICE is a DWE |
| | X'08' Expiration time |
| | X'10' Canceled by other task |
| | X'20' Expired on entry |
| | X'80' Expired normally |
| | X'F0' Expired mask |
+------------------+--------------------------------------------------+
| Userid | Associated userid |
+------------------+--------------------------------------------------+

Line Commands
The following table lists the line commands defined by the
&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Purge | Purges the selected ICE. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh the display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CICE command security


CICS

CICS Command

The CICS command changes the current target CICS address space.

The current target address space is referenced by any command that


displays information for a particular CICS address space.

When using the "First, Last, Next and Prev" parameters, the selected
new address space is based on the sorted list of CICS jobnames on the
local system.

Command Syntax

+------------------+--------------------------------------------------+
| CICS | [ target | First | Last | Next | Prev ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Value | Explanation |
+------------------+--------------------------------------------------+
| target | Specifies the target CICS jobname. |
| | The target can be specified by jobname or the |
| | VTAM applid for the CICS. |
+------------------+--------------------------------------------------+
| First | The first active CICS jobname. This is the |
| | default. |
+------------------+--------------------------------------------------+
| Last | The last active CICS jobname. |
+------------------+--------------------------------------------------+
| Next | The next active CICS from the current jobname. |
+------------------+--------------------------------------------------+
| Prev | The previous active CICS from the current |
| | jobname. |
+------------------+--------------------------------------------------+

Notes

CICSLIST Command
The CICSLIST command displays information about CICS address spaces
that are currently being monitored. CICS address spaces that are
currently inactive but have been monitored since the current IPL
are also displayed.

The CICS command can be used to dynamically switch between CICS


address spaces. By using the NEXT parameter of the CICS command,
you can cycle through all currently monitored CICS address spaces.

This process can be made easier by the using Leave Command Character
as defined in the PROFILE GENERAL miscellaneous section. When using
the Leave Command Character before a command on the command line,
the entered command remains on the command line after the Enter
key is pressed. This allows you to repeatedly enter the same command.
Example: Command ===] &CICS NEXT

The CICS NEXT command remains on the command line to switch


the monitoring to the next active CICS each time the Enter
key is pressed. The current screen command is not changed.
CICSDATA

CICSDATA Command

The CICSDATA command sets configuration options within the data


collector.

Command Syntax

+------------------+--------------------------------------------------+
| CICSDATA | function [parms] |
| | [options] |
+------------------+--------------------------------------------------+
| | Function and parameter syntax examples: |
| | |
| | Function Parameters |
| | ------------ ----------------------------------- |
| | TSD collection action |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Function | Specify the function to be executed. |
+------------------+--------------------------------------------------+
| TSD | Set the Time Series Data attributes for a |
| | collection. |
| | |
| | Parms: |
| | collection - The name of the Time Series Data |
| | collection. Valid values can be |
| | viewed on the command TSDSTATS. |
| | |
| | action - Action to be processed |
| | Valid values are: |
| | ENABLE - Enable collection |
| | DISABLE - Disable collection |
+------------------+--------------------------------------------------+
CICSLIST

CICSLIST Command

The CICSLIST command displays information about CICS address spaces


that are currently being monitored or have been monitored since the
last IPL. Additionally, address spaces that are not monitored
by SYSVIEW are also displayed.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CICSLIST | [ XSYStem | NOXSYstem ] |
| | |
| | [ GROUP group ] |
| | [ XSGROUP group ] |
| | |
| | [ ALL | MONitored ] |
| | |
| | [ SYSInterval | INTerval | TOTal ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | Display all CICS address spaces for all systems. |
| XSData | This forces cross system data collection to be |
| | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| GROUP group | Specifies the logical group name that contains |
| | a list of CICS jobnames to be displayed. |
| | |
| | You can use the group name "*" to indicate that |
| | no group processing is required. All CICS |
| | regions will be displayed. |
| | |
| | The list of logical groups defined as type |
| | CICSPLEX can be viewed using the GROUPS |
| | command. |
+------------------+--------------------------------------------------+
| ALL | Include all CICS address spaces. |
+------------------+--------------------------------------------------+
| MONITORED | Include only those CICS address spaces that |
| | are configured to be monitored. The CICS |
| | monitor has to have been started at least |
| | once within the CICS region. |
+------------------+--------------------------------------------------+
| SYSINTERVAL | Display transaction metrics based on the data |
| | collected during the last system interval. |
| | |
| | The data fields affected are: |
| | TranRate, CPUTime, Lifetime, SuspTime, |
| | WTRTime, FileTime, TermTime |
+------------------+--------------------------------------------------+
| INTERVAL | Display transaction metrics based on the data |
| | collected during the last data collection |
| | interval. |
| | |
| | The data fields affected are: |
| | TranRate, CPUTime, Lifetime, SuspTime, |
| | WTRTime, FileTime, TermTime |
+------------------+--------------------------------------------------+
| TOTAL | Display transaction metrics based on the data |
| | collected since the data collector was started. |
| | |
| | The data fields affected are: |
| | TranRate, CPUTime, Lifetime, SuspTime, |
| | WTRTime, FileTime, TermTime |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+
| Options | Lists the current effective options. These |
| | options can be the original initial defaults, |
| | defaults overridden with the OPTIONS subcommand, |
| | or options specified on the CICSLIST command. |
+------------------+--------------------------------------------------+
Data Fields

Default Sort Order: Status,A,Name,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Name | The name of the job. |
+------------------+--------------------------------------------------+
| ExecStage | The execution stage of the CICS region. |
| | Possible values are: |
| | |
| | INACTIVE - Inactive |
| | |
| | SWAPPED - Logically swapped |
| | |
| | INITIALIZE - Initialization |
| | INITIAL-1 - Initialization 1st stage |
| | INITIAL-2 - Initialization 2nd stage |
| | INITIAL-3 - Initialization 3rd stage |
| | |
| | EXECUTING - Executing |
| | |
| | CANCELED - Shutdown due to cancel |
| | CANCELED-1 - Shutdown due to cancel |
| | ..Quiesce 1st stage |
| | CANCELED-2 - Shutdown due to cancel |
| | ..Quiesce 2nd stage |
| | |
| | SHUTIMM - Shutdown immediate 1st stage |
| | SHUTIMM-1 - Shutdown immediate 2nd stage |
| | SHUTIMM-2 - Shutdown immediate 3rd stage |
| | |
| | SHUTDOWN - Shutdown 1st stage |
| | SHUTDOWN-1 - Shutdown 2nd stage |
| | SHUTDOWN-2 - Shutdown 3rd stage |
| | |
| | The status values for the field are based on |
| | MVS_CICSMON_ExecutionStatus state definitions |
| | found on the RULES command. |
| | |
+------------------+--------------------------------------------------+
| Status | The current monitoring status. |
| | Possible values are: |
| | |
| | ACTIVE The CICS monitor is active. |
| | |
| | Possible Execution Stages: |
| | Executing |
| | Shutdown stage 1 or 2 |
| | |
| | ACTIVEX The CICS monitor is active. |
| | |
| | The CICS is being monitored by |
| | a different instance of SYSVIEW |
| | which could be a different |
| | product subsystem or release. |
| | |
| | Possible Execution Stages: |
| | Executing |
| | Shutdown stage 1 or 2 |
| | |
| | CICSINIT The CICS monitor is not active. |
| | |
| | Possible Execution Stages: |
| | Initialization |
| | |
| | The CICS region has previously |
| | been monitored. |
| | |
| | CICSTERM The CICS monitor is not active. |
| | |
| | Possible Execution Stages: |
| | Cancel |
| | Shutdown |
| | |
| | The CICS region has previously |
| | been monitored. |
| | |
| | INACTIVE The CICS monitor is not active. |
| | |
| | Possible Execution Stages: |
| | Executing |
| | |
| | The CICS region has previously |
| | been monitored. |
| | |
| | JOBINACT The CICS monitor is not active. |
| | The CICS region is not active. |
| | |
| | Possible Execution Stages: |
| | Inactive |
| | |
| | The CICS region has previously |
| | been monitored. |
| | |
| | NONE The CICS monitor is not active. |
| | |
| | Possible Execution Stages: |
| | Initialization |
| | Cancel |
| | Shutdown |
| | |
| | The CICS monitor has never been |
| | active for this region since IPL. |
| | |
| | NOSTART The CICS monitor is not active. |
| | |
| | Possible Execution Stages: |
| | Executing |
| | |
| | The CICS monitor has never been |
| | active for this region since IPL. |
| | |
| | SWAPPED The CICS region is currently |
| | logically swapped out. |
| | |
| | The CICS monitor is either |
| | inactive or has never been |
| | active for this region since |
| | IPL. |
| | |
| | The status values for the field are based on |
| | MVS_CICSMON_MonitorStatus state definitions |
| | found on the RULES command. |
| | |
+------------------+--------------------------------------------------+
| RowStat | The overall or highest conditional status field |
| | displayed on the row. |
+------------------+--------------------------------------------------+
| Trans | The total transaction count since monitor |
| | initialization. |
| | |
| | The count includes those transactions that |
| | were excluded from statistical averaging due |
| | to excessive life time values. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| These fields do not include those transactions that were excluded |
| from statistical averaging due to excessive life time values. |
+------------------+--------------------------------------------------+
| TranRate | The transaction rate per second. |
+------------------+--------------------------------------------------+
| CPUTime | The average CPU used (in CPU seconds) by each |
| | transaction. |
+------------------+--------------------------------------------------+
| Lifetime | The average lifetime (in seconds) for each |
| | transaction. |
+------------------+--------------------------------------------------+
| SuspTime | The average suspend time (in seconds) for each |
| | transaction. |
+------------------+--------------------------------------------------+
| WTRTime | The average Waiting To Run time (in seconds) for |
| | each transaction. |
+------------------+--------------------------------------------------+
| FileTime | The average time, in seconds, spent processing |
| | file requests for each transaction. |
+------------------+--------------------------------------------------+
| TermTime | The average time, in seconds, spent performing |
| | or waiting for terminal I/O for each |
| | transaction. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| IOReqs | The number of I/O operations performed by the |
| | job. |
+------------------+--------------------------------------------------+
| JobCPU | The accumulated CPU time (in CPU seconds) used |
| | by the job. |
| | |
| | JobCPU = Job step time |
| | + SRB time |
| | + Accounted task time |
| | + Preemptable-class SRB time |
| | |
+------------------+--------------------------------------------------+
| Clocktime | The amount of wall clock time the job has been |
| | executing. |
+------------------+--------------------------------------------------+
| IFATime | The total CPU time executing on an IFA. |
| | |
| | IFATime = IFA CPU time |
| | + IFA enclave CPU time |
| | |
+------------------+--------------------------------------------------+
| IFA% | The percent of the total CPU time that executed |
| | on an IFA processor. |
| | |
| | IFA% = JobIFA * 100 |
| | --------------------- |
| | JobCPU |
| | |
+------------------+--------------------------------------------------+
| IFAonCP | The total CPU time that ran on a general |
| | processor that was eligible to run on an IFA |
| | processor. |
+------------------+--------------------------------------------------+
| IIPTime | The total CPU time executing on an IIP. |
| | |
| | IIPTime = IIP CPU time |
| | + IIP enclave CPU time |
| | |
+------------------+--------------------------------------------------+
| IIP% | The percent of the total CPU time that executed |
| | on an IIP processor. |
| | |
| | IIP% = IIPTime * 100 |
| | --------------------- |
| | JobCPU |
| | |
+------------------+--------------------------------------------------+
| IIPonCP | The total CPU time that ran on a general |
| | processor that was eligible to run on an IIP |
| | processor. |
+------------------+--------------------------------------------------+
| EnclTime | The total CPU time executing in an enclave. |
| | |
| | EnclTime = Enclave CPU time |
| | + IFA enclave CPU time |
| | + IIP enclave CPU time |
| | |
+------------------+--------------------------------------------------+
| Encl% | The percent of the total CPU time that executed |
| | in an enclave. |
| | |
| | Encl% = EnclTime * 100 |
| | --------------------- |
| | JobCPU |
| | |
+------------------+--------------------------------------------------+
| RealStg | The amount of real storage the job is using in |
| | the private region. |
+------------------+--------------------------------------------------+
| TSVer | The Transaction Server Version. |
| | Format TSv.r |
+------------------+--------------------------------------------------+
| Ver | The CICS internal version. |
| | Format v.r |
+------------------+--------------------------------------------------+
| Applid | The CICS specific application ID. |
+------------------+--------------------------------------------------+
| GApplid | The CICS generic application ID. |
+------------------+--------------------------------------------------+
| SysID | The CICS system ID. |
+------------------+--------------------------------------------------+
| SITName | The System Initialization Table name. |
+------------------+--------------------------------------------------+
| CICSTOD | The CICS Time-Of-Day. |
| | |
| | This value will be obtained for each CICS. |
| | All TOD values will not be identical since the |
| | values cannot be obtained at the same time. |
| | |
| | If the values are different by more than a few |
| | seconds, it most likely indicates that a |
| | CEMT PERFORM RESET should be performed. |
| | |
| | This can be true when a time change occurs. |
+------------------+--------------------------------------------------+
| Jobnr | The job number. |
+------------------+--------------------------------------------------+
| JobStat | The status of the job. |
| | Possible values are: |
| | |
| | NS Nonswappable |
| | LSW Logically swapped |
| | GO OUT Currently being swapped out |
| | GO IN Currently being swapped in |
| | IN Swapped in |
| | OUT TO Swapped out--terminal output wait |
| | OUT TI Swapped out--terminal input wait |
| | OUT LW Swapped out--long wait |
| | OUT XS Swapped out--auxiliary storage |
| | shortage |
| | OUT RS Swapped out--real storage shortage |
| | OUT DW Swapped out--detected wait |
| | OUT RQ Swapped out--requested swap |
| | OUT NQ Swapped out--enqueue exchange swap |
| | OUT EX Swapped out--exchange on recommended |
| | value |
| | OUT US Swapped out--unilateral swap |
| | OUT TS Swapped out--transition swap |
| | OUT IC Swapped out--improve central storage |
| | OUT IP Swapped out--improve system paging |
| | OUT MR Swapped out--make room |
| | OUT AW Swapped out--APPC wait |
| | OUT OI Swapped out--input wait |
| | OUT OO Swapped out--output wait |
| | OUT LS Swapped out--logical swap |
| | OUT LF Swapped out--logical swap fail |
| | OUT SR Swapped out--real swap |
| | blank No address space found with the |
| | specified jobname |
+------------------+--------------------------------------------------+
| Dispatch | The dispatchability of the address space. |
| | Possible values are: |
| | |
| | RUNNING - The address space has one or more |
| | units of work (tasks or SRBs) |
| | running on a processor. |
| | |
| | READYnnn - The address space has one or more |
| | units of work (tasks or SRBs) that |
| | are dispatchable but are waiting |
| | to run on a processor. The "nnn" |
| | portion is the dispatch priority |
| | order up to a maximum of 255. |
| | |
| | blank - The address space is not |
| | dispatchable. |
+------------------+--------------------------------------------------+
| Stepname | The current stepname. Stepnames are displayed |
| | only for jobs that have a stepname coded in the |
| | JCL. |
+------------------+--------------------------------------------------+
| Procname | The current procedure stepname. Procedure |
| | stepnames are displayed only for jobs that use a |
| | PROC statement in the JCL. |
+------------------+--------------------------------------------------+
| Type | The type of job. |
| | Possible values are: |
| | |
| | JOB - A batch job |
| | STC - A started task |
+------------------+--------------------------------------------------+
| JobClass | The job input class. |
+------------------+--------------------------------------------------+
| ASID | The hexadecimal address space ID. |
+------------------+--------------------------------------------------+
| ASCB | The ASCB address for the job. |
+------------------+--------------------------------------------------+
| CLOGJOBN | The CICS data logger jobname. |
+------------------+--------------------------------------------------+
| CICSLOGR | The CICS data logger task ID. |
+------------------+--------------------------------------------------+
| SSID | The SYSVIEW subsystem ID to which the CICS |
| | data collector is connected. |
+------------------+--------------------------------------------------+
| Rels | The SYSVIEW release to which the CICS |
| | data collector is connected. |
+------------------+--------------------------------------------------+
| GSVI | The CICS transaction ID for the long running |
| | product request task. |
+------------------+--------------------------------------------------+
| GSVS | The CICS transaction ID used to initialize the |
| | product. |
+------------------+--------------------------------------------------+
| GSVT | The CICS transaction ID used to terminate the |
| | product. |
+------------------+--------------------------------------------------+
| JobReq | Indicates if the job has been defined as a job |
| | that is required to be active. |
| | |
| | Possible values are: |
| | blank - job is not required to be active |
| | JOBREQ - job is required to be active |
| | |
| | Required jobs can be defined via the MONRULES |
| | command. |
| | |
| | Metric Exclude RsceScope |
| | MVS_JOB_Status INCLUDE jobname |
| | |
+------------------+--------------------------------------------------+
| Description | A description of the CICS region based on the |
| | jobname. |
| | |
| | The description for a CICS jobname is defined |
| | in the JOBNAMES parmlib member. |
+------------------+--------------------------------------------------+
| DSASize | The current size of the DSA. |
+------------------+--------------------------------------------------+
| DSAAllo | The current amount of storage allocated in the |
| | DSA. |
+------------------+--------------------------------------------------+
| DSAFree | The amount of free storage available in the DSA. |
+------------------+--------------------------------------------------+
| DSALim | The storage size limit for the DSA. |
+------------------+--------------------------------------------------+
| DSA% | The percent of the limit that is allocated. |
+------------------+--------------------------------------------------+
| EDSASize | The current size of the EDSA. |
+------------------+--------------------------------------------------+
| EDSAAllo | The current amount of storage allocated in the |
| | EDSA. |
+------------------+--------------------------------------------------+
| EDSAFree | The amount of free storage available in the |
| | EDSA. |
+------------------+--------------------------------------------------+
| EDSALim | The storage size limit for the EDSA. |
+------------------+--------------------------------------------------+
| EDSA% | The percent of the limit that is allocated. |
+------------------+--------------------------------------------------+
| GDSASize | The current size of the GDSA. |
+------------------+--------------------------------------------------+
| GDSAAllo | The current amount of storage allocated in the |
| | GDSA. |
+------------------+--------------------------------------------------+
| GDSAFree | The amount of free storage available in the |
| | GDSA. |
+------------------+--------------------------------------------------+
| GDSALim | The storage size limit for the GDSA. |
+------------------+--------------------------------------------------+
| GDSA% | The percent of the limit that is allocated. |
+------------------+--------------------------------------------------+
| PVTUser | Private storage user allocated. |
+------------------+--------------------------------------------------+
| PVTSys | Private storage system allocated. |
+------------------+--------------------------------------------------+
| PVTAlloc | Private storage total allocated. |
| | (User + Sys) |
+------------------+--------------------------------------------------+
| PVTFree | Private storage user unallocated or free. |
| | (Limit - User) |
+------------------+--------------------------------------------------+
| PVTS% | The percent of private size allocated. |
+------------------+--------------------------------------------------+
| PVTSize | The private storage size. |
+------------------+--------------------------------------------------+
| PVTL% | The percent of user storage limit allocated. |
+------------------+--------------------------------------------------+
| PVTLim | The private storage user limit. |
| | |
| | The current amount of storage available for |
| | allocation to the User region in private. This |
| | is a dynamic value based on the amount of system |
| | storage (Sys) allocated or the region limit, |
| | whichever is smaller. |
+------------------+--------------------------------------------------+
| EPVTUser | E-Private storage user allocated. |
+------------------+--------------------------------------------------+
| EPVTSys | E-Private storage system allocated. |
+------------------+--------------------------------------------------+
| EPVTAllo | E-Private storage total allocated. |
| | (User + Sys) |
+------------------+--------------------------------------------------+
| EPVTFree | E-Private storage user unallocated or free. |
| | (Limit - User) |
+------------------+--------------------------------------------------+
| EPVTS% | The percent of E-Private size allocated. |
+------------------+--------------------------------------------------+
| EPVTSize | The E-Private storage size. |
+------------------+--------------------------------------------------+
| EPVTL% | The percent of user storage limit allocated. |
+------------------+--------------------------------------------------+
| EPVTLim | The E-Private storage user limit. |
| | |
| | The current amount of storage available for |
| | allocation to the User region in private. This |
| | is a dynamic value based on the amount of system |
| | storage (Sys) allocated or the region limit, |
| | whichever is smaller. |
+------------------+--------------------------------------------------+
| Tasks | The current number of active tasks. |
+------------------+--------------------------------------------------+
| MxtTask | The current max task limit. |
+------------------+--------------------------------------------------+
| MxtTask% | The max task percentage. |
+------------------+--------------------------------------------------+
| MaxTask | CICS max task status. |
| | Possible values are: |
| | |
| | MAXTASK |
| | NOMAXTASK |
+------------------+--------------------------------------------------+
| VTAM | VTAM connection status. |
| | Possible values are: |
| | |
| | OPEN |
| | NONE |
| | QUIESCING |
| | QUIESCED |
| | CLOSED |
+------------------+--------------------------------------------------+
| TCPIP | TCP/IP connection status. |
| | Possible values are: |
| | |
| | NONE |
| | OPEN |
| | OPENING |
| | CLOSED |
| | CLOSING |
| | IMMCLOSING |
+------------------+--------------------------------------------------+
| WEB | WEB connection status. |
| | Possible values are: |
| | |
| | NONE |
| | INITIALIZING |
| | INITIALIZED |
| | QUIESCING |
| | QUIESCED |
| | TERMINATED |
+------------------+--------------------------------------------------+
| DB2SSID | DB2 connected subsystem ID. |
+------------------+--------------------------------------------------+
| DB2 | DB2 connection status. |
| | Possible values are: |
| | |
| | NONE |
| | CONNECTED |
| | CONNECTING |
| | DISCONNECTIN |
| | DISCONNECTED |
+------------------+--------------------------------------------------+
| QMGR | IBM MQ connected queue manager. |
+------------------+--------------------------------------------------+
| WebMQ | IBM MQ connection status. |
| | Possible values are: |
| | |
| | NONE |
| | CONNECTING |
| | PENDING |
| | CONNECTED |
| | QUIESCING |
| | STOPFORCE |
| | DISCONNECTED |
| | INACTIVE |
+------------------+--------------------------------------------------+
| IMSSSID | IMS connected subsystem ID. |
+------------------+--------------------------------------------------+
| DBCTL | DB Control connection status. |
| | Possible values are: |
| | |
| | NONE |
| | CONNECT-P1 |
| | CONNECT-P2 |
| | CONNECTED |
| | DISCONN-ORD |
| | DISCONN-IMM |
| | DISCONNECTED |
| | UNUSABLE |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands


+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| CANcel | Invokes the ASCANCEL command to cancel the |
| | selected ASID and jobname. |
+------------------+--------------------------------------------------+
| COLD | Issues an MVS modify command to cold start |
| | the initialization of the CICS data collection |
| | monitor. |
| | |
| | Command: "F jobname,GSVS START=COLD" |
+------------------+--------------------------------------------------+
| FLUSH | Requests that the records in the logging buffer |
| | be flushed and sent to the data logger (CICSLOGR)|
| | in the SYSVIEW address space. |
+------------------+--------------------------------------------------+
| INIT | Issues an MVS modify command to warm start |
| GSVS | the initialization of the CICS data collection |
| WARM | monitor. |
| | |
| | Command: "F jobname,GSVS START=WARM" |
+------------------+--------------------------------------------------+
| RESET | Correct the CICS local time by performing a |
| | CEMT PERFORM RESET. |
| | |
| | Command: "F jobname,CEMT PERFORM RESET" |
+------------------+--------------------------------------------------+
| RESTART | Restart monitoring for the selected CICS. |
| | |
| | Command: "CICSSET MONITOR RESTART JOB jobname" |
+------------------+--------------------------------------------------+
| Select | Invokes the ASID command for the selected CICS. |
| | |
| | This action selects the CICS address space to be |
| | used in future displays. The currently selected |
| | address space is displayed in the information |
| | section. For example: |
| | |
| | Jobname CICSPROD ASID 0039 |
+------------------+--------------------------------------------------+
| SHUTdown | Issues a CEMT PERFORM SHUTDOWN to the selected |
| | CICS. |
+------------------+--------------------------------------------------+
| SIMM | Issues a CEMT PERFORM SHUTDOWN,IMMEDIATE to the |
| | selected CICS. |
+------------------+--------------------------------------------------+
| START | Issues an MVS start command for the jobname. |
| STRT | |
+------------------+--------------------------------------------------+
| TERM | Terminates monitoring for the selected CICS. |
| | |
| | Command: "CICSSET MONITOR TERMINATE JOB jobname" |
+------------------+--------------------------------------------------+
| GSVT | Terminates monitoring for the selected CICS. |
| | |
| | Command: "F jobname,GSVT" |
+------------------+--------------------------------------------------+

Navigation Line Commands


+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Activity | Invokes the ACTIVITY command selecting the |
| | CICS jobname. |
+------------------+--------------------------------------------------+
| DASH | Invokes the CICS dashboard for the selected |
| | address space. |
+------------------+--------------------------------------------------+
| DSALLOC | Invokes the DSALLOC command for the selected |
| | address space. |
+------------------+--------------------------------------------------+
| DSAs | Invokes the CDSAS command to list the Dynamic |
| | Storage Areas in use. |
+------------------+--------------------------------------------------+
| JJobque | Invokes the JJOBQUE command for the selected |
| LIstjobs | CICS jobname. |
| LJ | |
+------------------+--------------------------------------------------+
| LISTFILE | Invokes the LISTFILE command for the selected |
| LF | CICS jobname. |
+------------------+--------------------------------------------------+
| LOgs | Invokes the LGLOGS command. |
+------------------+--------------------------------------------------+
| PACt | Plot CICS activity. |
+------------------+--------------------------------------------------+
| PCPu | Plot CICS CPU usage. |
+------------------+--------------------------------------------------+
| PDSA | Plot Dynamic Storage Areas. |
+------------------+--------------------------------------------------+
| PFIO | Plot file I/O activity. |
+------------------+--------------------------------------------------+
| PLIF | Plot transaction lifetime. |
+------------------+--------------------------------------------------+
| PLot | Invokes a "PLOTLIST CICS" command to display a |
| | plot selection list for the selected CICS. |
+------------------+--------------------------------------------------+
| PPAg | Plot CICS paging. |
+------------------+--------------------------------------------------+
| PPVt | Plot private storage usage. |
+------------------+--------------------------------------------------+
| PSTA | Plot status overview. |
+------------------+--------------------------------------------------+
| PSTG | Plot real storage usage. |
+------------------+--------------------------------------------------+
| PTSt | Plot temporary storage usage. |
+------------------+--------------------------------------------------+
| PUSe | Plot transaction CPU usage. |
+------------------+--------------------------------------------------+
| REView | Invokes the CREVIEW command to display an hourly |
| | breakdown of transaction activity. |
+------------------+--------------------------------------------------+
| SDATA | Invokes the CSYSDATA command for the selected |
| | jobname and logger. |
+------------------+--------------------------------------------------+
| SUBtask | Invokes the TASKS command to list the subtasks. |
+------------------+--------------------------------------------------+
| Tasks | Invokes the CTASKS command to list the active |
| | and suspended transactions. |
+------------------+--------------------------------------------------+
| TLOG | Invokes the CTRANLOG command for the selected |
| | jobname and logger. |
+------------------+--------------------------------------------------+
| TSUM | Invokes the CTRANSUM command for the selected |
| | jobname and logger. |
+------------------+--------------------------------------------------+
| XLOG | Invokes the XLOG command for the selected |
| | jobname and logger. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
| OPTions | Set and display command options. |
+------------------+--------------------------------------------------+

OPTIONS Subcommand

Use the OPTIONS subcommand to set and display CICSLIST command display
and processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [options] |
+---------------+-----------------------------------------------------+

OPTIONS Parameter Values

The following table lists and explains the valid OPTIONS parameter
values. Any number of the values can be specified in any order.
The current settings of all options are always displayed in
response to the OPTIONS subcommand.

+------------------+--------------------------------------------------+
| Value | Explanation |
+------------------+--------------------------------------------------+
| SYSInterval | Display transaction metrics based on the data |
| | collected during the last system interval. |
| | |
| | The data fields affected are: |
| | TranRate, CPUTime, Lifetime, SuspTime, |
| | WTRTime, FileTime, TermTime |
+------------------+--------------------------------------------------+
| INTerval | Display transaction metrics based on the data |
| | collected during the last data collection |
| | interval. |
| | |
| | The data fields affected are: |
| | TranRate, CPUTime, Lifetime, SuspTime, |
| | WTRTime, FileTime, TermTime |
+------------------+--------------------------------------------------+
| TOTal | Display transaction metrics based on the data |
| | collected since the data collector was started. |
| | |
| | The data fields affected are: |
| | TranRate, CPUTime, Lifetime, SuspTime, |
| | WTRTime, FileTime, TermTime |
+------------------+--------------------------------------------------+
| ALL | Include all CICS address spaces. |
+------------------+--------------------------------------------------+
| MONitored | Include only those CICS address spaces that |
| | are configured to be monitored. The CICS |
| | monitor has to have been started at least |
| | once within the CICS region. |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC |
| | variable. The variable created or updated is |
| | named SYSV_OPTIONS_CICSLIST. EXTRACT is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. EXTRACT can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+------------------+--------------------------------------------------+

Security Requirements

For security requirements, use the link: CICSLIST command security


CICSLOGR

CICSLOGR Command

The CICSLOGR command displays information about the defined


CICS data loggers.

Command Syntax

+------------------+--------------------------------------------------+
| CICSLOGR | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Data Fields

Default Sort Order: SSID,A,Jobname,A,CICSLOGR,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SSID | The subsystem ID. |
+------------------+--------------------------------------------------+
| Jobname | The name of the job that owns the logger. |
+------------------+--------------------------------------------------+
| CICSLOGR | The name of the CICS data logger task. |
+------------------+--------------------------------------------------+
| Status | The current status. |
| | Possible values are: |
| | |
| | ACTIVE - Logger is active |
| | INACTIVE - Logger is inactive |
+------------------+--------------------------------------------------+
| CICS | The number of active CICS client regions using |
| | this data logger. |
+------------------+--------------------------------------------------+
| Records | The number of records processed by the logger. |
+------------------+--------------------------------------------------+
| TranDet | The number of CICS transaction detail records |
| | that have been processed by the logger. |
+------------------+--------------------------------------------------+
| TranSum | The number of CICS transaction summary records |
| | that have been processed by the logger. |
+------------------+--------------------------------------------------+
| SysData | The number of CICS System Interval Data records |
| | that have been processed by the logger. |
+------------------+--------------------------------------------------+
| Thresh | The number of CICS threshold records |
| | that have been processed by the logger. |
+------------------+--------------------------------------------------+
| XLog | The number of native CICS exception records |
| | that have been processed by the logger. |
+------------------+--------------------------------------------------+
| Rate | The logging rate per minute. |
+------------------+--------------------------------------------------+
| LGSWrite | The number of records written to a log stream. |
+------------------+--------------------------------------------------+
| SMFWrite | The number of records written to SMF. |
+------------------+--------------------------------------------------+
| DynExit | The number of records passed to a dynamic |
| | exit. |
+------------------+--------------------------------------------------+
| TCPSend | The number of CICS transaction detail records |
| | that were attempted to be sent to CE APM |
| | using TCP/IP because they contained a tracing |
| | Correlation ID / GUID. |
+------------------+--------------------------------------------------+
| TCPByteS | The number of bytes sent using TCP/IP to a |
| | port specified in the PortList |
+------------------+--------------------------------------------------+
| zDMWrite | The number of records written to the |
| | CCS Data Mover. |
+------------------+--------------------------------------------------+
| WritDate | The date and time of the last logger write. |
| WritTime | |
+------------------+--------------------------------------------------+
| PCWrite | Records are transferred from a CICS region |
| | to the logger using a program call (PC). |
| | This value is the count of transfer requests |
| | that have been performed. |
+------------------+--------------------------------------------------+
| PCFlush | The number of times a CICS region has requested |
| | the logging buffers to be flushed. |
+------------------+--------------------------------------------------+
| ProcQ | The number of times the logger processed |
| | the record queue. |
+------------------+--------------------------------------------------+
| Post | Records are buffered prior to being written |
| | by the logger. This is the count of the number |
| | of times the logger was posted to write blocks |
| | of records. |
+------------------+--------------------------------------------------+
| Flush | Records are buffered prior to being written |
| | by the logger. This is the count of the number |
| | of times the logger was flushed to write blocks |
| | of records. |
+------------------+--------------------------------------------------+
| SegInU | The number of logging buffer segments in use. |
+------------------+--------------------------------------------------+
| InUse | The percentage of logging segments currently |
| | in use. |
+------------------+--------------------------------------------------+
| Discard | The number of records that have been discarded. |
+------------------+--------------------------------------------------+
| BufCnt | The number of logging buffers. |
+------------------+--------------------------------------------------+
| BufSize | The size of a single logging buffer. |
+------------------+--------------------------------------------------+
| BufTot | The total amount of E-PVT storage allocated |
| | as logging buffers. |
+------------------+--------------------------------------------------+
| SegCnt | The number of logging buffer segments. |
+------------------+--------------------------------------------------+
| SegSize | The size of a logging buffer segment. |
+------------------+--------------------------------------------------+
| PortList | The name of the logical group that contains a |
| | list of TCP/IP port numbers. CICS transaction |
| | tracing detail records will be sent to CE APM |
| | using this list of port numbers. |
| | |
| | Associated CICSLOGR parmlib option: |
| | Wily-Introscope-PortList |
| | |
| | See this help topic for more details: |
| | CE APM - CICS transaction trace integration |
+------------------+--------------------------------------------------+
| JobStat | The status of the job. |
| | Possible values are: |
| | |
| | NS Nonswappable |
| | LSW Logically swapped |
| | GO OUT Currently being swapped out |
| | GO IN Currently being swapped in |
| | IN Swapped in |
| | OUT TO Swapped out--terminal output wait |
| | OUT TI Swapped out--terminal input wait |
| | OUT LW Swapped out--long wait |
| | OUT XS Swapped out--auxiliary storage |
| | shortage |
| | OUT RS Swapped out--real storage shortage |
| | OUT DW Swapped out--detected wait |
| | OUT RQ Swapped out--requested swap |
| | OUT NQ Swapped out--enqueue exchange swap |
| | OUT EX Swapped out--exchange on recommended |
| | value |
| | OUT US Swapped out--unilateral swap |
| | OUT TS Swapped out--transition swap |
| | OUT IC Swapped out--improve central storage |
| | OUT IP Swapped out--improve system paging |
| | OUT MR Swapped out--make room |
| | OUT AW Swapped out--APPC wait |
| | OUT OI Swapped out--input wait |
| | OUT OO Swapped out--output wait |
| | OUT LS Swapped out--logical swap |
| | OUT LF Swapped out--logical swap fail |
| | OUT SR Swapped out--real swap |
| | blank No address space found with the |
| | specified jobname |
+------------------+--------------------------------------------------+
| CPU-Time | The accumulated CPU time (in CPU seconds) used |
| | by the job. |
+------------------+--------------------------------------------------+
| RealStg | The amount of real storage the job is using in |
| | the private region. |
+------------------+--------------------------------------------------+
| IOReqs | The number of I/O operations performed by the |
| | job. |
+------------------+--------------------------------------------------+
| Clocktime | The amount of wall clock time the job has been |
| | executing. |
+------------------+--------------------------------------------------+
| Rels | The release of the logger. |
+------------------+--------------------------------------------------+
| ISRV | The ISERVE name in use. |
+------------------+--------------------------------------------------+
| Jobnr | The job number. |
+------------------+--------------------------------------------------+
| ASID | The hexadecimal address space ID. |
+------------------+--------------------------------------------------+
| ASCB | The ASCB address for the job. |
+------------------+--------------------------------------------------+
| StrtDate | The date and time that the logger was started. |
| StrtTime | If INACTIVE, then this displays the date and |
| | time that the logger ended. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| TranLog | Status of transaction logging to a log stream. |
| | Possible values are: |
| | |
| | NOCICS - The licensed CICS option is not |
| | active. |
| | NONE - Logging is inactive. |
| | NO - Logging is inactive, but can be |
| | enabled. |
| | YES - Logging is active. |
+------------------+--------------------------------------------------+
| TranSMF | Status of SMF transaction logging. |
| | Possible values are: |
| | |
| | NOCICS - The licensed CICS option is not |
| | active. |
| | NO - Logging is inactive, but can be |
| | enabled. |
| | YES - Logging is active. |
+------------------+--------------------------------------------------+
| TranDyn | Status of transaction logging to the |
| | dynamic exit GSVX.CICSTRAN |
| | Possible values are: |
| | |
| | NOCICS - The licensed CICS option is not |
| | active. |
| | NO - Logging is inactive. |
| | YES - Logging is active. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| TSumLog | Status of transaction summary logging to a |
| | log stream. |
| | Possible values are: |
| | |
| | NOCICS - The licensed CICS option is not |
| | active. |
| | NONE - Logging is inactive. |
| | NO - Logging is inactive, but can be |
| | enabled. |
| | YES - Logging is active. |
+------------------+--------------------------------------------------+
| TSumSMF | Status of SMF transaction summary logging |
| | Possible values are: |
| | |
| | NOCICS - The licensed CICS option is not |
| | active. |
| | NO - Logging is inactive, but can be |
| | enabled. |
| | YES - Logging is active. |
+------------------+--------------------------------------------------+
| TSumDyn | Status of transaction summary logging to the |
| | dynamic exit GSVX.CICSTSUM |
| | Possible values are: |
| | |
| | NOCICS - The licensed CICS option is not |
| | active. |
| | NO - Logging is inactive |
| | YES - Logging is active. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| SysDLog | Status of system data logging to a log stream. |
| | Possible values are: |
| | |
| | NOCICS - The licensed CICS option is not |
| | active. |
| | NONE - Logging is inactive. |
| | NO - Logging is inactive, but can be |
| | enabled. |
| | YES - Logging is active. |
+------------------+--------------------------------------------------+
| SysDSMF | Status of SMF system data logging. |
| | Possible values are: |
| | |
| | NOCICS - The licensed CICS option is not |
| | active. |
| | NO - Logging is inactive, but can be |
| | enabled. |
| | YES - Logging is active. |
+------------------+--------------------------------------------------+
| SysDDyn | Status of system data logging to the |
| | dynamic exit GSVX.CICSSYSD |
| | Possible values are: |
| | |
| | NOCICS - The licensed CICS option is not |
| | active. |
| | NO - Logging is inactive. |
| | YES - Logging is active. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| XLogLog | Status of exception logging to a log stream. |
| | Possible values are: |
| | |
| | NOCICS - The licensed CICS option is not |
| | active. |
| | NONE - Logging is inactive. |
| | NO - Logging is inactive, but can be |
| | enabled. |
| | YES - Logging is active. |
+------------------+--------------------------------------------------+
| XLogSMF | Status of SMF exception logging. |
| | Possible values are: |
| | |
| | NOCICS - The licensed CICS option is not |
| | active. |
| | NO - Logging is inactive, but can be |
| | enabled. |
| | YES - Logging is active. |
+------------------+--------------------------------------------------+
| XLogDyn | Status of exception logging to the |
| | dynamic exit GSVX.CICSXLOG |
| | Possible values are: |
| | |
| | NOCICS - The licensed CICS option is not |
| | active. |
| | NO - Logging is inactive. |
| | YES - Logging is active. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| ASid | Invokes the ASID command for the jobname. |
+------------------+--------------------------------------------------+
| STArt | Starts the selected CICS logger. |
| STRt | |
+------------------+--------------------------------------------------+
| STOp | Stops the selected CICS logger. |
+------------------+--------------------------------------------------+
| Tasks | Invokes the TASKS command for the selected |
| | jobname. |
+------------------+--------------------------------------------------+
| TRANLOG | Enable transaction logging to log stream |
+------------------+--------------------------------------------------+
| NOTRANL | Disable transaction logging to log stream |
+------------------+--------------------------------------------------+
| TRANSMF | Enable SMF transaction logging |
+------------------+--------------------------------------------------+
| NOTRANS | Disable SMF transaction logging |
+------------------+--------------------------------------------------+
| SYSDLOG | Enable system data logging to log stream |
+------------------+--------------------------------------------------+
| NOSYSDL | Disable system data logging to log stream |
+------------------+--------------------------------------------------+
| SYSDSMF | Enable SMF system data logging |
+------------------+--------------------------------------------------+
| NOSYSDS | Disable SMF system data logging |
+------------------+--------------------------------------------------+
| TSUMLOG | Enable transaction summary logging to log stream |
+------------------+--------------------------------------------------+
| NOTSUML | Disable transaction summary logging to log stream|
+------------------+--------------------------------------------------+
| TSUMSMF | Enable SMF transaction summary logging |
+------------------+--------------------------------------------------+
| NOTSUMS | Disable SMF transaction summary logging |
+------------------+--------------------------------------------------+
| XLOGLOG | Enable exception logging to log stream |
+------------------+--------------------------------------------------+
| NOXLOGL | Disable exception logging to log stream |
+------------------+--------------------------------------------------+
| XLOGSMF | Enable SMF exception logging |
+------------------+--------------------------------------------------+
| NOXLOGS | Disable SMF exception logging |
+------------------+--------------------------------------------------+
| TCPstats | Issues an MVS modify command to the CICSLOGR |
| | task of the specified jobname to display TCP |
| | statistics for communications with CE APM. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Activity | Invokes the ACTIVITY command for the selected |
| | jobname. |
+------------------+--------------------------------------------------+
| DSalloc | Invokes the DSALLOC command for the selected |
| | jobname. |
+------------------+--------------------------------------------------+
| JJobque | Invokes the JJOBQUE command for the selected |
| | jobname. |
+------------------+--------------------------------------------------+
| LIstjobs | Invokes the LISTJOBS command for the selected |
| LJ | jobname. |
+------------------+--------------------------------------------------+
| LOgs | Invokes the LGLOGS command. |
+------------------+--------------------------------------------------+
| Select | Invokes the CICSLIST command for the selected |
| | logger and SSID. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
CICSLOGS

CICSLOGS Command

The CICSLOGS command displays active and inactive SYSVIEW


CICS logger tasks. The CICS logger topology shows the
connections between loggers, log streams and CICS jobs.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CICSLOGS | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
| | [ STATs | NOSTATs ] |
| | |
| | [ SSID ssid ] |
| | [ JOBname jobname ] |
| | [ CICSLogr cicslogr ] |
| | [ TYPE type ] |
| | [ LOGstream logstream ] |
| | [ CICSJobn cicsjobn ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross system data collection to be |
| XSData | set on for this execution of the command. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution of the command. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| STATs | Display statistics showing the date and time |
| | span of the data records contained in the |
| | log stream. |
| | |
| | A connection will be made to each log stream. |
| | The first and last record of each log stream |
| | will be read to determine the range of data |
| | contained in the log stream. Log stream |
| | data sets can become archived if not used |
| | regularly. This can cause the processing to |
| | be slow when a data set must be recalled. |
+------------------+--------------------------------------------------+
| NOSTATs | Do not show statistics showing the date and time |
| | span of the data records contained in the |
| | log stream. |
+------------------+--------------------------------------------------+
| SSID | Limit the display to only those entries with a |
| | corresponding value in the "SSID" field. |
| | |
| | Wildcard masking characters can be specified. |
+------------------+--------------------------------------------------+
| JOBname | Limit the display to only those entries with a |
| | corresponding value in the "Jobname" field. |
| | |
| | Wildcard masking characters can be specified. |
+------------------+--------------------------------------------------+
| CICSLogr | Limit the display to only those entries with a |
| | corresponding value in the "CICSLOGR" field. |
| | |
| | Wildcard masking characters can be specified. |
+------------------+--------------------------------------------------+
| TYPE | Limit the display to only those entries with a |
| | corresponding value in the "Type" field. |
| | |
| | Wildcard masking characters can be specified. |
+------------------+--------------------------------------------------+
| LOGstream | Limit the display to only those entries with a |
| | corresponding value in the "LogStream" field. |
| | |
| | Wildcard masking characters can be specified. |
+------------------+--------------------------------------------------+
| CICSJobn | Limit the display to only those entries with a |
| | corresponding value in the "CICSJobn" field. |
| | |
| | Wildcard masking characters can be specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,SSID,A,Jobname,A,Rels,A,CICSLOGR,A,


Type,A,LogStream,A,CICSJobn,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SSID | The subsystem ID. |
+------------------+--------------------------------------------------+
| Jobname | The name of the job that owns the logger. |
+------------------+--------------------------------------------------+
| Rels | The release of the logger. |
+------------------+--------------------------------------------------+
| CICSLOGR | The name of the CICS data logger task. |
| | |
| | The CICSLOGR field will be highlighted if the |
| | task is inactive. |
+------------------+--------------------------------------------------+
| Type | The CICS logger type. |
| | |
| | Possible values are: |
| | |
| | EITL - CICS EXEC interface transaction log |
| | SYSD - CICS system interval data log |
| | TRAN - CICS transaction detail log |
| | TSUM - CICS transaction summary log |
| | XLOG - Exception log |
+------------------+--------------------------------------------------+
| LogStream | The name of the log stream. |
+------------------+--------------------------------------------------+
| CICSJobn | The jobname of the CICS region connected to the |
| | logger. |
| | |
| | The CICSJobn field will be highlighted if the |
| | jobname connection to the logger is inactive. |
+------------------+--------------------------------------------------+
| ErrStat | The error status indicator. |
| | |
| | Possible values are: |
| | blanks - No error occurred while accessing |
| | the log stream. |
| | EMTPY - The log stream is empty. |
| | NOTFOUND - The log stream is not defined to |
| | the MVS logger. |
| | SAFAUTH - A SAF security error occurred |
| | while trying to access the |
| | log stream. |
| | |
+------------------+--------------------------------------------------+
| TimeSpan | The time span of the data within the log stream. |
| | span = end - begin |
+------------------+--------------------------------------------------+
| RetPd | The retention period defined to the log stream. |
+------------------+--------------------------------------------------+
| Bgn-Date | The date of the first block in the log stream. |
+------------------+--------------------------------------------------+
| Bgn-Time | The time of the first block in the log stream. |
+------------------+--------------------------------------------------+
| End-Date | The date of the last block in the log stream. |
+------------------+--------------------------------------------------+
| End-Time | The time of the last block in the log stream. |
+------------------+--------------------------------------------------+
| LogType | The log stream type. |
| | |
| | Possible values are: |
| | CF - Coupling facility log stream |
| | DASDONLY - DASD only log stream |
| | |
+------------------+--------------------------------------------------+
| BlkSize | The maximum block size that can be written |
| | to the log stream. |
+------------------+--------------------------------------------------+
| Command | The command used to browse the log stream. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands
The following table lists the line commands defined by the
&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Requests | Invokes the CICSLOGR command for the selected |
| | entry to show the requests made through the |
| | associated CICS logger. |
+------------------+--------------------------------------------------+
| Select | Browse the selected log stream. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
CICSSET

CICSSET Command

The CICSSET command provides a set of functions that can take actions
on or alter resources in a CICS region. Many of the functions are
executed as line commands from other primary command displays.

The functions can be targeted to the following:

* Current system
o Current CICS region
o A specific CICS region
o All CICS regions
o A specified logical group of CICS regions

* Remote systems
o A specific CICS region
o All CICS regions
o A specified logical group of CICS regions
o CICS regions in a logical group of remote systems

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CICSSET | function [parms] [targetparms] [options] |
| | |
| | -or- |
| | |
| | [targetparms] [options] function [parms] |
| | |
+------------------+--------------------------------------------------+

Target Parameters
+------------------+--------------------------------------------------+
| [targetparms] | [ JOBname jobname | * | ALL ] |
| | [ GROUP group ] |
| | [ SYSTEM system | * | ALL ] |
| | [ XSGROUP group ] |
| | [ MEMBER member | * ] |
+------------------+--------------------------------------------------+
| See Target parms below. |
+------------------+--------------------------------------------------+

Options
+------------------+--------------------------------------------------+
| [options] | [ MSG ] |
| | [ NOMSG ] |
+------------------+--------------------------------------------------+
| See Options below. |
+------------------+--------------------------------------------------+

Function and Parameters


+------------------+--------------------------------------------------+
| function [parms] | Function Parameters |
| | ------------ ---------------------------------- |
| | ALLOCATE ddname dsn [disp] |
| | CANCEL tasknumber |
| | CEDA cics_ceda_parameters |
| | CEMT cics_cemt_parameters |
| | CHKPOINT datatype |
| | CICSKILL tasknumber |
| | CKILL tasknumber |
| | CONFIG option value |
| | CONNECT connection action |
| | DSALIM limit |
| | EDSALIM limit |
| | EXPORT datatype dsn(member) |
| | FILE filename action |
| | FLUSH |
| | FORCEPUR tasknumber |
| | FREEDDN ddname |
| | JVMSERV server action |
| | KILL tasknumber |
| | LIBRARY library action |
| | LIBRARY library RANKING rank |
| | MAXTasks limit |
| | MODENAME modename action |
| | MODENAME modename AVAILABLE available |
| | MONITOR action |
| | MQMON mqmonitor action |
| | MXT limit |
| | PROGRAM program action |
| | PURGE tasknumber |
| | SAVE datatype |
| | TCLASS class attributes |
| | TCPIPService service action |
| | TDQUEUE queue action |
| | TERMinal term action |
| | TRAN tran action |
| | TRAN tran PRIority pri |
| | TSD collection action |
| | TSQUEUE queue action |
| | UOW uow action |
| | VDEFINELOGS |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Function | Description |
+------------------+--------------------------------------------------+
| ALLOCATE | Dynamically allocate a data set. |
| | |
| | Parms: |
| | ddname - DDname to be allocated |
| | dsn - Data set name to be allocated |
| | disp - Disposition |
| | Valid values are: |
| | SHR |
| | OLD |
+------------------+--------------------------------------------------+
| CANCEL | Cancel requested task. |
| | |
| | Parms: |
| | tasknumber - task number to be canceled |
| | |
| | Progressive methods: |
| | |
| | CEKL SET TASK(number) PURGE |
| | |
| | If task still exists then |
| | CEKL SET TASK(number) FORCEPURGE |
+------------------+--------------------------------------------------+
| CEDA | Issue CEDA request. |
| | |
| | Parms: |
| | Any CICS CEDA syntax parameters |
| | |
| | Request syntax: |
| | CICSSET [targetparms] [options] CEDA parms |
| | |
| | "CEDA parms" must be the last syntax parameters |
| | in the CICSSET command request string. |
+------------------+--------------------------------------------------+
| CEMT | Issue CEMT request. |
| | |
| | Parms: |
| | Any CICS CEMT syntax parameters |
| | |
| | Request syntax: |
| | CICSSET [targetparms] [options] CEMT parms |
| | |
| | "CEMT parms" must be the last syntax parameters |
| | in the CICSSET command request string. |
+------------------+--------------------------------------------------+
| CHKPOINT | Checkpoint data definitions. |
| | |
| | Data definitions will only be saved if the data |
| | has been changed. |
| | |
| | Parms: |
| | datatype - Data definition type |
| | Valid data types are: |
| | ALL |
| | ARTM |
| | DUMPMGT |
| | SCHEDULE |
| | STATS |
+------------------+--------------------------------------------------+
| CKILL | Kill requested task. |
| CICSKILL | |
| | Parms: |
| | tasknumber - task number to be killed |
| | |
| | Method: |
| | |
| | CEKL SET TASK(number) KILL |
| | |
| | A PURGE or FORCEPUR should be attempted prior |
| | to issuing a CKILL. |
+------------------+--------------------------------------------------+
| CONFIG | Set CICS monitor configuration options. |
| | |
| | Syntax: CONFIG option value |
| | |
| | Parameter Description |
| | ---------- --------------------------------- |
| | option configuration option |
| | value new value to be set |
| | |
| | Optional Target Parameters |
| | Keyword Parameter Description |
| | ---------- --------- ---------------------- |
| | MEMBER member The parmlib member |
| | name associated with |
| | the configuration |
| | option. |
| | Valid values are: |
| | SVWCOPTS |
| | SVWCTSD |
| | |
| | If a member name is |
| | not supplied, SVWCOPTS |
| | will be used. |
| | |
| | Examples: |
| | |
| | CICSSET CONFIG ABEND-NOTIFICATION SHORT |
| | CICSSET JOBNAME * CONFIG ABEND-NOTIFICATION SHORT|
| | CICSSET MEMBER SVWCOPTS CONFIG ABEND-NOTIFICATION|
| | SHORT |
| | |
| | See CCONFIG command for a list of options. |
+------------------+--------------------------------------------------+
| CONNECT | Set CICS remote connection command. |
| | |
| | Parms: |
| | connection - CICS remote connection SYSID |
| | action - Action to be taken |
| | Valid actions are: |
| | ACQUIRED |
| | BACKOUT |
| | CANCEL |
| | COMMIT |
| | ENDAFFINITY |
| | FCANCEL |
| | FORCEPURGE |
| | INSERVICE |
| | NOTPENDING |
| | OUTSERVICE |
| | PURGE |
| | RELEASED |
| | RESYNC |
| | FORCEUOW |
+------------------+--------------------------------------------------+
| DSALIM | Set new DSA limit value. |
| | |
| | Parms: |
| | limit - New DSA limit value |
| | Value can be specified using |
| | storage suffixes such as K,M,G |
| | Example: 5M |
+------------------+--------------------------------------------------+
| EDSALIM | Set new EDSA limit value. |
| | |
| | Parms: |
| | limit - New EDSA limit value |
| | Value can be specified using |
| | storage suffixes such as K,M,G |
| | Example: 50M |
+------------------+--------------------------------------------------+
| EXPORT | Export data definitions. |
| | |
| | Syntax: EXPORT datatype dsname(member) |
| | |
| | Parameter Description |
| | ---------- --------------------------------- |
| | datatype Data definition type |
| | Valid data types are: |
| | ARTM |
| | DUMPMGT |
| | SCHEDULE |
| | STATS |
| | |
| | member The name of the member to be |
| | saved. |
| | |
| | dsname The data set name where the |
| | specified member is to be saved. |
| | |
| | The data set name can be |
| | specified as a fully qualified |
| | data set name or using one of the |
| | following special keywords: |
| | |
| | Keyword Description |
| | ---------- ------------------------------- |
| | USER Use the optional data set name |
| | defined in the user profile |
| | for the library type PARMLIB. |
| | |
| | Example: USER(member) |
| | |
| | SITE Use the optional site PARMLIB |
| | date set that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITE(member) |
| | |
| | SYSTEM Use the system PARMLIB data set |
| | that is defined in the system |
| | configuration options parmlib |
| | member: GSVXGSVX |
| | |
| | Example: SYSTEM(member) |
| | |
| | SITESYSTEM Use the first defined data |
| | SITE.SYSTEM set from the following list |
| | * of eligible data set names: |
| | |
| | * Optional site data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | * The system data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITESYSTEM(member) |
| | SITE.SYSTEM(member) |
| | *(member) |
| | |
| | USERSITE Use the first defined data |
| | USER.SITE set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | current library type. |
| | |
| | * Optional site data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSITE(member) |
| | USER.SITE(member) |
| | |
| | USERSYSTEM Use the first defined data |
| | USER.SYSTEM set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | current library type. |
| | |
| | * The system data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSYSTEM(member) |
| | USER.SYSTEM(member) |
| | |
| | The above keywords can be cursor selected |
| | invoking a hyperlink to the LIBS command |
| | showing the available data sets for the |
| | keyword. |
| | |
| | Note: |
| | The writing of the exported data to a data set |
| | member occurs under the DATALIB task in the |
| | Main Services address space. The userid |
| | associated with the Main Services address space |
| | will need UPDATE access to the data set. |
+------------------+--------------------------------------------------+
| FILE | Set CICS file command. |
| | |
| | Parms: |
| | file - CICS file name |
| | action - Action to be taken |
| | Valid actions are: |
| | OPEN |
| | CLOSE |
| | ENABLE |
| | DISABLE |
+------------------+--------------------------------------------------+
| FLUSH | Requests that the records in the logging buffer |
| | be flushed and sent to the data logger |
| | (CICSLOGR). |
+------------------+--------------------------------------------------+
| FORCEpur | Force purge requested task. |
| | |
| | Parms: |
| | tasknumber - task number to be force purged |
| | |
| | Method: |
| | |
| | CEKL SET TASK(number) FORCEPURGE |
+------------------+--------------------------------------------------+
| FREEDDN | Dynamically free a ddname. |
| | |
| | Parms: |
| | ddname - DDname to be freed |
+------------------+--------------------------------------------------+
| JVMSERV | Set CICS JVM server command. |
| | |
| | Parms: |
| | server - CICS JVM server name |
| | action - Action to be taken |
| | Valid actions are: |
| | ENABLED |
| | DISABLED |
| | FORCEPURGE |
| | KILL |
| | PHASEOUT |
| | PURGE |
+------------------+--------------------------------------------------+
| KILL | Kill requested task. |
| | |
| | Parms: |
| | tasknumber - task number to be killed |
| | |
| | Progressive methods: |
| | |
| | CEKL SET TASK(number) PURGE |
| | |
| | If task still exists then |
| | CEKL SET TASK(number) FORCEPURGE |
| | |
| | If task still exists then |
| | CEKL SET TASK(number) KILL |
+------------------+--------------------------------------------------+
| LIBRARY | Set CICS library command. |
| | |
| | Parms: |
| | library - CICS library name |
| | action - Action to be taken |
| | Valid actions are: |
| | ENABLED |
| | DISABLED |
| | CRITICAL |
| | NONCRITICAL |
| | |
| | Set CICS library ranking |
| | RANKING rank |
| | Minimum = 1 |
| | Maximum = 99 |
| | 10 is reserved to DFHRPL |
+------------------+--------------------------------------------------+
| MAXTasks | Set new MAXTASKS limit value. |
| MXT | |
| | Parms: |
| | limit - New MAXTASKS limit value |
| | The value must be in the range |
| | 1 to 2000. |
+------------------+--------------------------------------------------+
| MODENAME | Set CICS MODENAME command. |
| | |
| | Parms: |
| | modename - The mode group name |
| | action - Action to be taken |
| | Valid actions are: |
| | ACQUIRED |
| | CLOSED |
| | |
| | Set CICS MODENAME available sessions |
| | AVAILable available |
| | Minimum = 0 |
| | Maximum = 999 |
+------------------+--------------------------------------------------+
| MONITOR | Set the state of data collection. |
| | |
| | Parms: |
| | action - Action to be taken |
| | Valid actions are: |
| | TERMINATE |
| | RESTART |
+------------------+--------------------------------------------------+
| MQMON | Set CICS mqmonitor command. |
| | |
| | Parms: |
| | mqmonitor - CICS mqmonitor name |
| | action - Action to be taken |
| | Valid actions are: |
| | AUTOSTART |
| | DISABLED |
| | ENABLED |
| | NOAUTOSTART |
| | STARTED |
| | STOPPED |
+------------------+--------------------------------------------------+
| PROGRAM | Set CICS program command. |
| | |
| | Parms: |
| | program - CICS program name |
| | action - Action to be taken |
| | Valid actions are: |
| | ENABLE |
| | DISABLE |
| | NEWCOPY |
| | PHASEIN |
+------------------+--------------------------------------------------+
| PURGE | Purge requested task. |
| | |
| | Parms: |
| | tasknumber - task number to be purged |
| | |
| | Method: |
| | |
| | CEKL SET TASK(number) PURGE |
+------------------+--------------------------------------------------+
| SAVE | Save data definitions. |
| | Data definitions will be saved even if the data |
| | is unchanged. SAVE will ALWAYS save the data. |
| | This is different from the CHKPOINT function. |
| | |
| | Parms: |
| | datatype - Data definition type |
| | Valid data types are: |
| | ALL |
| | ARTM |
| | DUMPMGT |
| | SCHEDULE |
| | STATS |
+------------------+--------------------------------------------------+
| TCLASS | Set CICS transaction class command. |
| | |
| | Parms: |
| | class - CICS transaction class |
| | attributes - Attributes to be set |
| | Valid attributes are: |
| | MAX |
| | PURGE |
| | |
| | MAX value |
| | Minimum = 0 |
| | Maximum = 999 |
| | |
| | PURGE value |
| | Minimum = 0 |
| | Maximum = 1000000 |
+------------------+--------------------------------------------------+
| TCPIPService | Set CICS TCPIPSERVICE command. |
| | |
| | Parms: |
| | service - TCP/IP service name |
| | action - Action to be taken |
| | Valid actions are: |
| | OPEN |
| | CLOSE |
| | IMMCLOSE |
+------------------+--------------------------------------------------+
| TDQUEUE | Set CICS transient data queue command. |
| | |
| | Parms: |
| | queue - Transient data queue |
| | action - Action to be taken |
| | Valid actions are: |
| | CLOSE |
| | DISABLE |
| | ENABLE |
| | OPEN |
+------------------+--------------------------------------------------+
| TERMinal | Set CICS terminal command. |
| | |
| | Parms: |
| | term - CICS terminal name |
| | action - Action to be taken |
| | Valid actions are: |
| | ACQUIRED |
| | CANCEL |
| | CREATE |
| | FORCE |
| | INSERVICE |
| | KILL |
| | NOCREATE |
| | OUTSERVICE |
| | PURGE |
| | RELEASE |
+------------------+--------------------------------------------------+
| TRAN | Set CICS transaction command. |
| | |
| | Parms: |
| | tran - CICS transaction ID |
| | action - Action to be taken |
| | Valid actions are: |
| | ENABLE |
| | DISABLE |
| | PURGEABLE |
| | NOTPURGEABLE |
| | SPURGE |
| | NOSPURGE |
| | |
| | Set CICS transaction priority |
| | PRIority pri |
| | Minimum priority = 1 |
| | Maximum priority = 255 |
+------------------+--------------------------------------------------+
| TSD | Set Time Series Data actions. |
| | |
| | Parms: |
| | collection - Time Series Data collection name |
| | action - Action to be taken |
| | Valid actions are: |
| | ENABLE |
| | DISABLE |
+------------------+--------------------------------------------------+
| TSQUEUE | Set CICS temporary storage queue command. |
| | |
| | Parms: |
| | queue - Queue name (16 characters) |
| | If the queue name contains |
| | non-displayable or non-typeable |
| | characters, the queue name |
| | can be entered using the HEX |
| | format: |
| | X'xxxxxx...xxxxx' (32 hex chars) |
| | action - Action to be taken |
| | Valid actions are: |
| | DELETE |
+------------------+--------------------------------------------------+
| UOW | Set CICS unit-of-work command. |
| | |
| | Parms: |
| | uow - Local Unit-Of-Work (16 chars) |
| | action - Action to be taken |
| | Valid actions are: |
| | BACKOUT |
| | COMMIT |
| | FORCE |
+------------------+--------------------------------------------------+
| VDEFINELOGS | Set log stream variables. |
| | |
| | Examples: |
| | |
| | CICSSET JOBNAME * VDEFINELOGS |
| | CICSSET JOBNAME CICSPROD VDEFINELOGS |
| | |
| | All parameters other than JOBNAME will be |
| | ignored. |
| | |
| | The following variables will be defined and can |
| | be used for substitution. |
| | |
| | CICSEITL_LogStream |
| | CICSSYSD_LogStream |
| | CICSTRAN_LogStream |
| | CICSTSUM_LogStream |
| | CICSXLOG_LogStream |
| | |
| | The values can be viewed using the VLIST command.|
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Target parms | Description |
+------------------+--------------------------------------------------+
| JOBname | Target CICS jobname. |
| | If the jobname is not specified or the jobname |
| | is specified as "*", the currently active ASID |
| | will be used. |
| | |
| | If the jobname is specified as "ALL", then the |
| | requested function will be issued for each |
| | active CICS region within the local system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of CICS regions. The requested function will |
| | be issued for each active CICS region within the |
| | specified group. |
| | |
| | The list of available groups with type CICSPLEX |
| | can be found on the GROUPS command. |
+------------------+--------------------------------------------------+
| SYSTEM | Target system name. |
| | |
| | If the system name is not specified or the |
| | system name is specified as "*", the current |
| | system name will be used. |
| | |
| | If the system name is specified as "ALL", |
| | then the requested function will be issued |
| | to all systems. |
+------------------+--------------------------------------------------+
| XSGROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of system names. The requested function will |
| | be issued for each active system within the |
| | specified group. |
| | |
| | The list of available groups with type XSSYSTEM |
| | can be found on the GROUPS command. |
+------------------+--------------------------------------------------+
| MEMBER | The parmlib member name associated with the |
| | configuration option being set. This optional |
| | target parameter is only valid for the CONFIG |
| | function. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Options | Description |
+------------------+--------------------------------------------------+
| MSG | Messages will be issued. |
+------------------+--------------------------------------------------+
| NOMSG | Messages will not be issued. |
| | |
| | If a command syntax error occurs, a message |
| | will be issued. |
+------------------+--------------------------------------------------+

Notes

Command Syntax Examples


+---------------------------------------------------------------------+
| Function Parameters |
| ------------ ----------------------------------------------------- |
| ALLOCATE ddname dsn [disp] |
| CANCEL tasknumber |
| CEDA cics_ceda_parameters |
| CEMT cics_cemt_parameters |
| CHKPOINT datatype |
| CICSKILL tasknumber |
| CKILL tasknumber |
| CONFIG option value |
| CONNECT connection action |
| DSALIM limit |
| EDSALIM limit |
| EXPORT datatype dsn(member) |
| FILE filename action |
| FLUSH |
| FORCEPUR tasknumber |
| FREEDDN ddname |
| JVMSERV server action |
| KILL tasknumber |
| LIBRARY library action |
| LIBRARY library RANKING rank |
| MAXTasks limit |
| MODENAME modename action |
| MODENAME modename AVAILABLE available |
| MONITOR action |
| MQMON mqmonitor action |
| MXT limit |
| PROGRAM program action |
| PURGE tasknumber |
| SAVE datatype |
| TCLASS class MAX value |
| TCPIPService service action |
| TDQUEUE queue action |
| TERMinal term action |
| TRAN tran action |
| TRAN tran PRIority pri |
| TSQUEUE queue action |
| UOW uow action |
| |
+---------------------------------------------------------------------+

Security Requirements

For security requirements see CICSSET command security


CIPCONN

CIPCONN Command

The CIPCONN command displays IP connections to a remote system


or CICS region. Any statistical field values are since the
last CICS statistics reset.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CIPCONN | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,IPConn,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| IPConn | The name of the IP connection. |
+------------------+--------------------------------------------------+
| Network | The network ID of the remote system. |
+------------------+--------------------------------------------------+
| Applid | The applid or name that the remote system is |
| | known to the network. |
+------------------+--------------------------------------------------+
| TCPIPS | The name of the TCPIP Service definition that |
| | defines attributes of the inbound processing. |
+------------------+--------------------------------------------------+
| SecName | The security name of the remote system. |
+------------------+--------------------------------------------------+
| ServStat | Service status |
| | |
| | Possible values are: |
| | |
| | IN - In service |
| | Out - Out of service |
+------------------+--------------------------------------------------+
| ConnStat | Connection status |
| | |
| | Possible values are: |
| | |
| | ACQUIRED |
| | FREEING |
| | OBTAINING |
| | RELEASED |
+------------------+--------------------------------------------------+
| Auto | Auto connect indicator |
+------------------+--------------------------------------------------+
| Pending | Pending status |
+------------------+--------------------------------------------------+
| RecoverStat | Recovery status |
| | |
| | Possible values are: |
| | |
| | NORECOVDATA - Neither side has recovery |
| | information outstanding |
| | NRS - CICS does not have recovery |
| | outstanding, but the partner |
| | may have |
| | RECOVDATA - There are in-doubt units |
| | of work |
+------------------+--------------------------------------------------+
| XLNStat | XLN status |
| | |
| | Possible values are: |
| | |
| | XNOTDONE |
| | XOK |
+------------------+--------------------------------------------------+
| XLNAct | XLN Action |
| | |
| | Possible values are: |
| | |
| | FORCE |
| | KEEP |
+------------------+--------------------------------------------------+
| Partner | Partner locality |
| | |
| | Possible values are: |
| | |
| | LOCAL |
| | NETWORK |
| | SYSPLEX |
+------------------+--------------------------------------------------+
| UAPart | User authorization of partner |
| | |
| | Possible values are: |
| | |
| | DEFAULT |
| | IDENTIFY |
| | LOCAL |
| | VERIFY |
+------------------+--------------------------------------------------+
| SSL | SSL indicator |
+------------------+--------------------------------------------------+
| LinkAuth | Link authorization |
| | |
| | Possible values are: |
| | |
| | CERTUSER |
| | SECUSER |
+------------------+--------------------------------------------------+
| UserAuth | User authorization |
| | |
| | Possible values are: |
| | |
| | DEFAULT |
| | IDENTIFY |
| | LOCAL |
| | VERIFY |
+------------------+--------------------------------------------------+
| Port | The port number to be used for outbound |
| | requests. |
| | A value of "NO" indicates no port value. |
+------------------+--------------------------------------------------+
| IPAddress | The IP address of the remote system. |
+------------------+--------------------------------------------------+
| Host | The host name of the remote system. |
+------------------+--------------------------------------------------+
| ISsent | IS bytes sent |
+------------------+--------------------------------------------------+
| ISrecv | IS bytes received |
+------------------+--------------------------------------------------+
| DPLsent | DPL bytes sent |
+------------------+--------------------------------------------------+
| DPLrecv | DPL bytes received |
+------------------+--------------------------------------------------+
| ICsent | IC bytes sent |
+------------------+--------------------------------------------------+
| ICrecv | IC bytes received |
+------------------+--------------------------------------------------+
| TRsent | TR bytes sent |
+------------------+--------------------------------------------------+
| TRrecv | TR bytes received |
+------------------+--------------------------------------------------+
| SendSock | The number of send sockets. |
+------------------+--------------------------------------------------+
| SockLim | The negotiated socket limit. |
+------------------+--------------------------------------------------+
| SendCnt | The send count. |
+------------------+--------------------------------------------------+
| SendLim | The negotiated send limit. |
+------------------+--------------------------------------------------+
| QLimit | The queue limit. |
| | A value of "NO" indicates no limit. |
+------------------+--------------------------------------------------+
| MaxQTime | The max queue time. |
| | A value of "NO" indicates no limit. |
+------------------+--------------------------------------------------+
| LQItems | The number of items on the local queue. |
+------------------+--------------------------------------------------+
| DPLreqs | The number of DPL requests sent. |
+------------------+--------------------------------------------------+
| ICreqs | The number of IC requests sent. |
+------------------+--------------------------------------------------+
| TRreqs | The number of TR requests sent. |
+------------------+--------------------------------------------------+
| Trans | The number of transactions attached. |
+------------------+--------------------------------------------------+
| RTimeout | The read timeout value. |
+------------------+--------------------------------------------------+
| RecvSock | The number of receive sockets. |
+------------------+--------------------------------------------------+
| RecvCnt | The receive count. |
+------------------+--------------------------------------------------+
| RecvLim | The negotiated receive limit. |
+------------------+--------------------------------------------------+
| SSess | The current number of send sessions. |
+------------------+--------------------------------------------------+
| PSSess | The peak number of send sessions. |
+------------------+--------------------------------------------------+
| RSess | The current number of receive sessions. |
+------------------+--------------------------------------------------+
| PRSess | The peak number of receive sessions. |
+------------------+--------------------------------------------------+
| AllocS | The total number of Allocate Sends. |
+------------------+--------------------------------------------------+
| AllocQ | The current number of Allocate Sends that |
| | are queued. |
+------------------+--------------------------------------------------+
| QAllocS | The number of Allocate Sends since queue |
| | started. |
+------------------+--------------------------------------------------+
| PQAlloc | The peak number of Allocate Send requests |
| | that were queued. |
+------------------+--------------------------------------------------+
| AllocFL | The number of Allocate Sends that failed due |
| | to connection OUT or RELEASED. |
+------------------+--------------------------------------------------+
| AllocFO | The number of Allocate Sends that failed due |
| | to sessions not available. |
+------------------+--------------------------------------------------+
| RejectQL | The number of Allocate Sends rejected due |
| | to queue limit. |
+------------------+--------------------------------------------------+
| QPurge | The number of times the queue of Allocate Sends |
| | were purged due to max queue time. |
+------------------+--------------------------------------------------+
| SPurge | The number of Allocate Sends purged due to |
| | max queue time. |
+------------------+--------------------------------------------------+
| XISQUER | The number of Allocate Sends rejected due to a |
| | user exit. |
+------------------+--------------------------------------------------+
| XISQUEQ | The number of times the queue of Allocate Sends |
| | were purged due to a user exit. |
+------------------+--------------------------------------------------+
| XISQUEP | The number of Allocate Sends purged due to a |
| | user exit. |
+------------------+--------------------------------------------------+
| FreeSend | The number of Free Sends while queue is in a |
| | purged state. |
+------------------+--------------------------------------------------+
| QDate | The date and time of the when the queue of |
| QTime | Allocate Sends started. |
+------------------+--------------------------------------------------+
| ISCB | The address of the ISCB control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.
Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CJINFO

CJINFO Command

The CJINFO command displays statistical and status information for


the journals that have been defined to CICS.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CJINFO | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Name,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname that owns the entry. |
+------------------+--------------------------------------------------+
| Name | The name of the journal. |
+------------------+--------------------------------------------------+
| Type | The journal type. Valid values are: |
| | |
| | MVS |
| | SMF |
| | DUMMY |
+------------------+--------------------------------------------------+
| SYSLOG | Specifies that the journal is a system log. |
+------------------+--------------------------------------------------+
| Stream-Name | The name of the log stream. |
+------------------+--------------------------------------------------+
| Status | The status of the journal. Valid values are: |
| | |
| | ENABLED |
| | DISABLED |
| | FAILED |
| | UNABLE_TO_CREATE |
| | SYSLOG_CONFLICT |
| | JOURNALHASFAILED |
| | ERROR_OPEN_LOG |
| | WRITE_ERROR |
+------------------+--------------------------------------------------+
| Write | The journal write count. |
+------------------+--------------------------------------------------+
| Bytes | The total number of bytes written. |
+------------------+--------------------------------------------------+
| Flush | The number of flushes. |
+------------------+--------------------------------------------------+
| Token | The log stream token. The Logbuf token for SMF. |
+------------------+--------------------------------------------------+
| LGJI | The address of the LGJI control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CJINFO command security


CJMODEL

CJMODEL Command

The CJMODEL command displays a list of CICS journal model


definitions.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CJMODEL | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Model,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname that owns the entry. |
+------------------+--------------------------------------------------+
| Model | The journal model name. |
+------------------+--------------------------------------------------+
| Name | The journal name. |
+------------------+--------------------------------------------------+
| Type | The journal type. Valid values are: |
| | |
| | MVS |
| | SMF |
| | DUMMY |
+------------------+--------------------------------------------------+
| Stream-Name | The prototype log stream name. |
+------------------+--------------------------------------------------+
| LGJMC | The address of the LGJMC control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CJMODEL command security


CJVMPROG

CJVMPROG Command

The CJVMPROG display provides information and status for CICS


JVM programs.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CJVMPROG | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Program,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Program | Program name |
+------------------+--------------------------------------------------+
| Count | The use count |
+------------------+--------------------------------------------------+
| Lang | The program language |
+------------------+--------------------------------------------------+
| ExecKey | The execution key |
+------------------+--------------------------------------------------+
| DataLoc | The default data location |
+------------------+--------------------------------------------------+
| ExecSet | The execution set |
+------------------+--------------------------------------------------+
| CEDF | Indicates that CEDF is available |
+------------------+--------------------------------------------------+
| Debug | Indicates that JVM debug is enabled |
+------------------+--------------------------------------------------+
| Disabled | Indicates that the program is disabled |
| | Possible values are: |
| | DISABLED - program is disabled |
| | blank - program is enabled |
+------------------+--------------------------------------------------+
| ThreadSafe | Indicates that the program is defined to be |
| | threadsafe |
+------------------+--------------------------------------------------+
| CopyStatus | The load status of a program. |
| | Possible values are: |
| | REQUIRED |
| | NOTREQUIRED |
+------------------+--------------------------------------------------+
| Remote | Indicates the program is a remote definition |
+------------------+--------------------------------------------------+
| RProgram | The name of the remote program. |
+------------------+--------------------------------------------------+
| RSysID | The name of the remote system. |
+------------------+--------------------------------------------------+
| RTran | The name of the remote transaction ID. |
+------------------+--------------------------------------------------+
| Server | The JVM server name. |
+------------------+--------------------------------------------------+
| Profile | The JVM profile. |
+------------------+--------------------------------------------------+
| DefGroup | The name of the definition group from where |
| | the entry was installed. |
+------------------+--------------------------------------------------+
| JVMClass | The JVM class name. |
+------------------+--------------------------------------------------+
| PPTE | The address of the PPTE control block |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DISable | Disables the program so that it is not available |
| | for use. |
+------------------+--------------------------------------------------+
| ENAble | Enables the program so that it is available for |
| | use. |
+------------------+--------------------------------------------------+
| NEWcopy | Requests a new copy of the program to be loaded. |
| NC | |
+------------------+--------------------------------------------------+
| PHasein | Requests a new copy of the program to be phased |
| | in. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CJVMSERV

CJVMSERV Command

The CJVMSERV display provides information and status for CICS


JVM servers.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CJVMSERV | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Server,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Server | JVM server name |
+------------------+--------------------------------------------------+
| Status | The status of the server. |
| | Possible values are: |
| | |
| | ENABLED |
| | ENABLING |
| | DISABLED |
| | DISABLNG |
| | DISCARD |
+------------------+--------------------------------------------------+
| Task# | The task number assigned to the JVM server |
+------------------+--------------------------------------------------+
| Count | JVM use count |
+------------------+--------------------------------------------------+
| InUse | Current threads in use |
+------------------+--------------------------------------------------+
| UseHWM | The peak or high water mark of threads in use |
+------------------+--------------------------------------------------+
| Limit | The thread limit |
+------------------+--------------------------------------------------+
| Waits | The number of waits due to thread limit |
+------------------+--------------------------------------------------+
| Waiting | The current number waiting on a thread |
+------------------+--------------------------------------------------+
| WaitHWM | The peak or high water mark waiting on threads |
+------------------+--------------------------------------------------+
| WaitTime | The total time waiting on threads |
+------------------+--------------------------------------------------+
| SysCount | System thread use count |
+------------------+--------------------------------------------------+
| SysWaits | System thread waits |
+------------------+--------------------------------------------------+
| SysWaiting | Current waiting on system thread |
+------------------+--------------------------------------------------+
| SysWaitHWM | Waiting on system thread high water mark |
+------------------+--------------------------------------------------+
| HeapSize | Current heap size |
+------------------+--------------------------------------------------+
| HeapHWM | Heap size high water mark |
+------------------+--------------------------------------------------+
| HeapInit | Initial heap size |
+------------------+--------------------------------------------------+
| HeapMax | Maximum heap size |
+------------------+--------------------------------------------------+
| Occupancy | Heap size at last garbage collection |
+------------------+--------------------------------------------------+
| CodeUsed | Code cache memory used |
| | |
| | Requires CICS TS 6.1 or higher. |
+------------------+--------------------------------------------------+
| CodeAlloc | Code cache memory allocated |
| | |
| | Requires CICS TS 6.1 or higher. |
+------------------+--------------------------------------------------+
| DataUsed | Data cache memory used |
| | |
| | Requires CICS TS 6.1 or higher. |
+------------------+--------------------------------------------------+
| DataAlloc | Data cache memory allocated |
| | |
| | Requires CICS TS 6.1 or higher. |
+------------------+--------------------------------------------------+
| ClassUsed | Class storage memory used |
| | |
| | Requires CICS TS 6.1 or higher. |
+------------------+--------------------------------------------------+
| ClassAlloc | Class storage memory allocated |
| | |
| | Requires CICS TS 6.1 or higher. |
+------------------+--------------------------------------------------+
| ShrFree | The current free space within the JVM's |
| | shared class cache. |
| | |
| | Requires CICS TS 6.1 or higher. |
+------------------+--------------------------------------------------+
| ShrSize | The JVM's shared class cache size limit. |
| | |
| | Requires CICS TS 6.1 or higher. |
+------------------+--------------------------------------------------+
| GCEventsMajor | Major garbage collection events |
+------------------+--------------------------------------------------+
| GCHeapMajor | Heap freed in major garbage collection |
+------------------+--------------------------------------------------+
| GCTimeMajor | Elapsed time in major garbage collection |
+------------------+--------------------------------------------------+
| GCEventsMinor | Minor garbage collection events |
+------------------+--------------------------------------------------+
| GCHeapMinor | Heap freed in minor garbage collection |
+------------------+--------------------------------------------------+
| GCTimeMinor | Elapsed time in minor garbage collection |
+------------------+--------------------------------------------------+
| GCPolicy | Garbage collection policy |
+------------------+--------------------------------------------------+
| PID | Process ID hexidecimal |
+------------------+--------------------------------------------------+
| PIDD | Process ID decimal |
+------------------+--------------------------------------------------+
| TCB | The TCB owning the JVM |
+------------------+--------------------------------------------------+
| LERunOpts | The LE Run options value |
+------------------+--------------------------------------------------+
| Profile | The JVM profile name |
+------------------+--------------------------------------------------+
| JavaVers | The Java version |
+------------------+--------------------------------------------------+
| JVMDate | JVM creation date |
+------------------+--------------------------------------------------+
| JVMTime | JVM creation time |
+------------------+--------------------------------------------------+
| DefGroup | The name of the definition group from where |
| | the entry was installed. |
+------------------+--------------------------------------------------+
| ProfileDirectory | JVM profile directory |
+------------------+--------------------------------------------------+
| JSR | The address of the JSR control block |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| ENAble | Issue an ENABLED request for the selected |
| | JVM server. |
| | |
| | Cmd issued: CICSSET JVMSERV server ENABLED |
+------------------+--------------------------------------------------+
| DISable | Issue a DISABLED request for the selected |
| | JVM server. |
| | |
| | Cmd issued: CICSSET JVMSERV server DISABLED |
+------------------+--------------------------------------------------+
| FORCepurge | Issue a FORCEPURGE request for the selected |
| | JVM server. Tasks that are running in the JVM |
| | server are force purged. |
| | |
| | A PURGE should be used before FORCEPURGE. |
| | |
| | Cmd issued: CICSSET JVMSERV server FORCEPURGE |
+------------------+--------------------------------------------------+
| KILL | Issue a KILL request for the selected |
| | JVM server. Tasks that are running in the JVM |
| | server are terminated. |
| | |
| | A FORCEPURGE should be used before KILL. |
| | |
| | Cmd issued: CICSSET JVMSERV server KILL |
+------------------+--------------------------------------------------+
| PHASEout | Issue a PHASEOUT request for the selected |
| | JVM server. Tasks that are running in the JVM |
| | will continue until completion. No new work |
| | is started. |
| | |
| | Cmd issued: CICSSET JVMSERV server PHASEOUT |
+------------------+--------------------------------------------------+
| PURGE | Issue a PURGE request for the selected |
| | JVM server. Tasks that are running in the JVM |
| | server are purged. |
| | |
| | Cmd issued: CICSSET JVMSERV server PURGE |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| ENV | Invokes the LEENVAR command to display the |
| | language environment variables for the |
| | selected server. |
+------------------+--------------------------------------------------+
| PRof | Invokes the USSCMD command to display the |
| | contents of the JVM profile. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.
If the command is executed in SYSTEM mode or XSYSTEM mode, when
supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CJVMSERV command security


CKTCB

CKTCB Command

The CKTCB command displays a list of TCB table entries (KTCB).

Command Syntax

+------------------+--------------------------------------------------+
| CKTCB | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Type | The TCB type or TCB mode. |
+------------------+--------------------------------------------------+
| Status | The status of the entry. If this value is |
| | ACTIVE, then the entry is currently active. If |
| | it is blank, then the entry is currently |
| | inactive. |
+------------------+--------------------------------------------------+
| TCBTime | The accumulated TCB time. |
+------------------+--------------------------------------------------+
| Abend999 | The type of Abend 999 request. Valid values |
| | are: |
| | |
| | RUNAWAY |
| | RESETPSW |
+------------------+--------------------------------------------------+
| Active | The current active task entry index number. |
+------------------+--------------------------------------------------+
| ActTCBID | The active TCB ID used for trace. |
+------------------+--------------------------------------------------+
| TAS-Act | The current active task entry (TASENTRY). |
+------------------+--------------------------------------------------+
| Default | The default task entry index number. |
+------------------+--------------------------------------------------+
| DefTCBID | The default TCB ID used for trace. |
+------------------+--------------------------------------------------+
| TAS-Dflt | The default task entry (TASENTRY). |
+------------------+--------------------------------------------------+
| MVS-TCB | The address of MVS TCB for the KTCB entry. |
+------------------+--------------------------------------------------+
| KTCB | The address of the KTCB control block. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CLIBS

CLIBS Command

The CLIBS command displays a list of CICS dynamic application


libraries.

The TASKLIB/STEPLIB/JOBLIB concatenations are also included


in the display but should not be considered part of the
CICS dynamic application library structure.

The WHERE subcommand or parameter can be used to search all


libraries for a specific or generic member and display summary
information about each member found.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CLIBS | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
| | [ WHERE member ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
| WHERE member | All libraries will be searched for the specific |
| | or generic member name. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

If the WHERE subcommand is used in XSYSTEM mode, the following


information will only represent the statistics gathered from the
local system.

+------------------+--------------------------------------------------+
| Member | The member name that the WHERE subcommand |
| | searches for. |
+------------------+--------------------------------------------------+
| Found | The number of matches found by the WHERE |
| | subcommand. |
+------------------+--------------------------------------------------+
| DataSets | The total number of CLIBS data sets. |
+------------------+--------------------------------------------------+
| Alloc | The number of unique data sets successfully |
| | allocated. |
+------------------+--------------------------------------------------+
| Open | The number of unique data sets successfully |
| | opened. |
+------------------+--------------------------------------------------+
| Search | The number of data sets searched by the WHERE |
| | subcommand. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Module,A,


Ranking,A,Library,A,Seq,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Library | Library name |
+------------------+--------------------------------------------------+
| Search | Search order position |
| | The search order value will be 0 for disabled |
| | entries. |
+------------------+--------------------------------------------------+
| Ranking | Ranking of library |
+------------------+--------------------------------------------------+
| Dsnames | Number of data sets |
+------------------+--------------------------------------------------+
| Status | The enablement status |
| | Possible values are: |
| | UNKNOWN |
| | ENABLED |
| | DISABLED |
| | ENABLING |
| | DISABLING |
| | DISCARDING |
+------------------+--------------------------------------------------+
| Critical | Library is critcal |
+------------------+--------------------------------------------------+
| Seq | Data set sequence/concatenation number |
+------------------+--------------------------------------------------+
| DatasetName | Data set name |
+------------------+--------------------------------------------------+
| Found | This field displays the number of matching |
| | member names found when using the WHERE |
| | subcommand. |
+------------------+--------------------------------------------------+

The following fields will contain data when the WHERE subcommand
is used and a single matching member is found.

+------------------+--------------------------------------------------+
| LinkDate | The date member was link-edited. |
+------------------+--------------------------------------------------+
| Size | The size of the module. |
+------------------+--------------------------------------------------+
| AC | The authorization code. |
+------------------+--------------------------------------------------+
| RM | The residency mode. |
+------------------+--------------------------------------------------+
| AM | The addressing mode. |
+------------------+--------------------------------------------------+
| Attributes | The member attributes. |
| | Possible values are: |
| | |
| | FO - F-level linkage editor |
| | RF - Refreshable |
| | RN - Reentrant |
| | RU - Reusable |
| | NX - Not executable |
| | OL - Only loadable |
| | NE - Not editable |
| | SC - Scatter load format |
| | OV - Overlay format |
| | TS - Linked with TEST |
| | |
+------------------+--------------------------------------------------+
| Message | This field contains data when WHERE subcommand |
| | is used and an error occurs while access the |
| | data set. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| CRItical | Set the library to critical. |
| | This function is equivalent to: |
| | |
| | CEMT SET LIBRARY(library) CRITICAL |
+------------------+--------------------------------------------------+
| DISabled | Disables the library. |
| | This function is equivalent to: |
| | |
| | CEMT SET LIBRARY(library) DISABLED |
+------------------+--------------------------------------------------+
| ENAbled | Enables the library. |
| | This function is equivalent to: |
| | |
| | CEMT SET LIBRARY(library) ENABLED |
+------------------+--------------------------------------------------+
| NONcrit | Set the library to non-critical. |
| | This function is equivalent to: |
| | |
| | CEMT SET LIBRARY(library) NONCRITICAL |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| FL | Invokes the user command FILELIST to display the |
| | members found in the data sets for the selected |
| | library. |
+------------------+--------------------------------------------------+
| LD | Invokes the LISTDIR command for the selected |
| | data set name. |
+------------------+--------------------------------------------------+
| LMid | Invokes the LISTDIR command for the selected |
| | data set with the MODID keyword to display |
| | standard module identification information |
| | for all members in the data set. |
+------------------+--------------------------------------------------+
| Select | Invokes the DSALLOC command selecting the |
| | library name. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| WHERE member | All libraries will be searched for the specific |
| | or generic member name. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CLIBS command security


CLIFE

CLIFE Command

The CLIFE command displays a lifetime summary for a transaction,


by ranges, since the start of the SYSVIEW for CICS data collector.

The information can be shown summarizing all transactions grouped


together, by transaction, or by defined transaction group.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CLIFE | [ TRAN = ] |
| | tran ] |
| | group ] |
| | |
| | |
| | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| TRAN | Specify the transaction ID for which the |
| | lifetime range is to be displayed. |
| | |
| | = - All transaction |
| | |
| | tran - specific transaction ID |
| | If mixed case is needed enter as: |
| | |
| | c'tran' |
| | |
| | group - transaction group |
| | |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+
| Tran | Specified transaction ID or group |
+------------------+--------------------------------------------------+
| Transactions | The total number of transactions. |
| | The count includes those transactions that |
| | were excluded from statistical averaging due |
| | to excessive life time values. |
+------------------+--------------------------------------------------+
| Lifetime Average | The average lifetime of all transactions. |
+------------------+--------------------------------------------------+
| Maximum | The maximum lifetime of all transactions. |
+------------------+--------------------------------------------------+

Data Fields
Default Sort Order: XSSystem,A,Jobname,A,Range,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Range | The time range for the transaction lifetime. |
| | |
| | The transaction count includes all transactions |
| | with a lifetime less than or equal to the |
| | range value. |
| | |
| | The last entry will contain a "+" as a prefix. |
| | This entry contains all transactions with a |
| | lifetime greater than the range value. |
+------------------+--------------------------------------------------+
| Count | The number of transactions within the lifetime |
| | range not including the prior range. |
| | The count includes those transactions that |
| | were excluded from statistical averaging due |
| | to excessive life time values. |
+------------------+--------------------------------------------------+
| Pct% | The percentage of transactions within the |
| | lifetime range. |
+------------------+--------------------------------------------------+
| APct% | The cumulative percentage of transactions |
| | (percentage in the current lifetime range plus |
| | (percentages in all preceding lifetime ranges). |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CLIFESUM

CLIFESUM Command

The CLIFESUM command displays a lifetime range distribution


for transactions that have executed since the start of the
SYSVIEW for CICS data collector.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CLIFESUM | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
| | [ PCT | COUNT ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
| PCT | Display range values as percentages of count. |
+------------------+--------------------------------------------------+
| COUNT | Display range values as counts. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Tran,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Tran | Transaction ID |
+------------------+--------------------------------------------------+
| Count | The number of transactions that have executed. |
+------------------+--------------------------------------------------+
| AvgLife | The average lifetime for the transaction. |
+------------------+--------------------------------------------------+
| MaxLife | The maximum lifetime for the transaction. |
+------------------+--------------------------------------------------+
| 0.100 | The number or percentage of transactions that |
| | have a lifetime in the following range: |
| | |
| | Minimum Maximum |
| | 0.000000 to 0.100000 |
| | |
+------------------+--------------------------------------------------+
| 0.250 | The number or percentage of transactions that |
| | have a lifetime in the following range: |
| | |
| | Minimum Maximum |
| | 0.001001 to 0.250000 |
| | |
+------------------+--------------------------------------------------+
| 0.500 | The number or percentage of transactions that |
| | have a lifetime in the following range: |
| | |
| | Minimum Maximum |
| | 0.250001 to 0.500000 |
| | |
+------------------+--------------------------------------------------+
| 1.000 | The number or percentage of transactions that |
| | have a lifetime in the following range: |
| | |
| | Minimum Maximum |
| | 0.500001 to 1.000000 |
| | |
+------------------+--------------------------------------------------+
| 2.000 | The number or percentage of transactions that |
| | have a lifetime in the following range: |
| | |
| | Minimum Maximum |
| | 1.000001 to 2.000000 |
| | |
+------------------+--------------------------------------------------+
| 5.000 | The number or percentage of transactions that |
| | have a lifetime in the following range: |
| | |
| | Minimum Maximum |
| | 2.000001 to 5.000000 |
| | |
+------------------+--------------------------------------------------+
| 10.000 | The number or percentage of transactions that |
| | have a lifetime in the following range: |
| | |
| | Minimum Maximum |
| | 5.000001 to 10.000000 |
| | |
+------------------+--------------------------------------------------+
| 30.000 | The number or percentage of transactions that |
| | have a lifetime in the following range: |
| | |
| | Minimum Maximum |
| | 10.000001 to 30.000000 |
| | |
+------------------+--------------------------------------------------+
| 60.000 | The number or percentage of transactions that |
| | have a lifetime in the following range: |
| | |
| | Minimum Maximum |
| | 30.000001 to 60.000000 |
| | |
+------------------+--------------------------------------------------+
| +60.000 | The number or percentage of transactions that |
| | have a lifetime in the following range: |
| | |
| | Minimum |
| | 60.000001 |
| | |
+------------------+--------------------------------------------------+
XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Deg | Invokes the CWAITS command to show degradation |
| | analysis for the selected transaction. |
+------------------+--------------------------------------------------+
| Select | Invokes the CLIFE command to show lifetime |
| | analysis for the selected transaction. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CLIST

CLIST Command

The CLIST command executes a list of SYSVIEW commands contained in


a specified data set member.

Command Syntax

+----------+----------------------------------------------------------+
| CLIST | mbrname [dsname] [parms] |
+----------+----------------------------------------------------------+

-or-

+----------+----------------------------------------------------------+
| CLIST | dsname(mbrname) [parms] |
+----------+----------------------------------------------------------+

Parameters

+--------------+------------------------------------------------------+
| Parameter | Explanation |
+--------------+------------------------------------------------------+
| mbrname | Specifies the CLIST library member name to be |
| | executed. |
+--------------+------------------------------------------------------+
| dsname | Specifies the optional data set name of the library |
| | containing the CLIST member. |
| | |
| | The data set name can be specified as a fully |
| | qualified data set by enclosing it in character |
| | delimiters. |
| | |
| | If you omit the character delimiters, then your data |
| | set name prefix is left appended to the data set |
| | name. |
| | |
| | Data set name can be specified using one of the |
| | following special keywords: |
| | |
| | Keyword Description |
| | ---------- ------------------------------- |
| | USER Use the optional data set name |
| | defined in the user profile for the |
| | CLISTDSN keyword. |
| | |
| | Example: USER(member) |
| | |
| | SITE Use the optional CLISTLIB site data |
| | set that is defined in the system |
| | configuration options parmlib |
| | member: GSVXSYSV |
| | |
| | Example: SITE(member) |
| | |
| | SYSTEM Use the CLISTLIB system data set that |
| | is defined in the system |
| | configuration options parmlib |
| | member: GSVXSYSV |
| | |
| | Example: SYSTEM(member) |
| | |
| | SITESYSTEM Concatentate the following |
| | SITE.SYSTEM data sets to search for the |
| | * specified member name: |
| | |
| | * Optional CLISTLIB site data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXSYSV |
| | |
| | * The CLISTLIB system data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXSYSV |
| | |
| | Example: SITESYSTEM(member) |
| | SITE.SYSTEM(member) |
| | *(member) |
| | |
| | USERSITE Concatentate the following |
| | USER.SITE data sets to search for the |
| | specified member name: |
| | |
| | * Optional data set name defined |
| | in the user profile for the |
| | CLISTDSN keyword. |
| | |
| | * Optional CLISTLIB site data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXSYSV |
| | |
| | Example: USERSITE(member) |
| | USER.SITE(member) |
| | |
| | USERSYSTEM Concatentate the following |
| | USER.SYSTEM data sets to search for the |
| | specified member name: |
| | |
| | * Optional data set name defined |
| | in the user profile for the |
| | CLISTDSN keyword. |
| | |
| | * The CLISTLIB system data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXSYSV |
| | |
| | Example: USERSYSTEM(member) |
| | USER.SYSTEM(member) |
| | |
| | The above keywords can be cursor selected |
| | invoking a hyperlink to the LIBS command |
| | showing the available data sets for the |
| | keyword. |
| | |
+--------------+------------------------------------------------------+
| parms | You can specify one or more parameters to be |
| | passed to the CLIST. The parameters are passed |
| | as command variables named &1, &2, ... for as |
| | many parameters as you specify. |
| | |
| | If you omit a parameter by specifying two |
| | consecutive commas, then that parameter has |
| | a null value. |
| | |
| | ex: CLIST USER(MYCLIST) parm1,,parm3 |
| | |
| | Any parameter that contains blanks or commas must be |
| | enclosed in character delimiters. |
| | |
| | The commands in the CLIST member can refer to |
| | these variables or to any other command |
| | variables defined by the VDEFINE command. |
| | |
| | The VLIST command displays defined variables |
| | and their current values. |
| | |
| | If you use the first syntax, but omit the optional |
| | data set name, you must specify a comma in place of |
| | the data set name. For example: |
| | |
| | CLIST MYCLIST , parm1,parm2,parm3 |
| | -or- |
| | CLIST MYCLIST ,parm1,parm2,parm3 |
+------------------+--------------------------------------------------+

Notes

The following notes explain how to use certain features of the CLIST
command:

* CLIST libraries must be cataloged data sets with fixed record format,
blocked or unblocked, with record length of 80 (RECFM=F,LRECL=80).

* Only columns 1 to 71 of a CLIST member record are processed.


Columns 72 through 80 are ignored.

* Records with an asterisk (*) in column 1 are treated as comments


and ignored.

* Records containing blanks in columns 1-71 are ignored unless a


continuation was expected. In this case, the blank record is
processed and terminates the previously continued command.

* Commands are coded in a CLIST member in the same way they are
coded on the command line.

* Commands can be continued by coding a continuation character as


the last nonblank character on a line. A hyphen ("-") indicates
that leading blanks in the next record are not ignored. A plus
sign ("+") indicates that leading blanks in the next record are
ignored. The only restriction on the number of continuation
records is that the total length of the actual resulting command
cannot exceed 256 characters.
* Comments bracketed by /* and */ are permitted before, within, and
after a command and its operands. Comments are considered to be a
part of a command or a command itself, and they are subject to the
length restrictions described above.

* If you use the CLIST mbrname dsname format of the CLIST command
and you want to omit the dsname but specify parameters, then you
must code two consecutive commas following the mbrname to indicate
that the dsname has been omitted.

Messages

CLIS001E Invalid CLIST - maximum command length of 240 exceeded

The CLIST command specified a member containing a command that


exceeded the maximum length allowed.

CLIS002E Invalid CLIST - expected continuation not received

The CLIST command specified a member containing a command that


terminated with a continuation character, but no continuation was
found.

CLIS003I Added to stack:

This message appears only in the system activity log. It precedes


the list of commands that the CLIST command has added to the command
input stack.
CLISTLIB

CLISTLIB Command

The CLISTLIB command displays your personal CLIST library,


the site CLIST library, and the system CLIST library.

For information about other related library listing commands see:


Library Listing Command Summary

Command Syntax

+---------------+------------------------------------------------------------+
| CLISTLIB | |
+---------------+------------------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Options | This field lists the following option keywords: |
| | |
| | ALL |
| | DUPLICAT |
| | UNIQUE |
| | |
| | These fields are cursor selectable. Positioning the cursor |
| | over one of the above keywords and hitting the ENTER key |
| | will invoke the subcommand of the same name. |
| | |
| | If SET TABINFOOPTS YES is in effect then you can use the |
| | NEWLINE or TAB keys to position the cursor to the keyword. |
| | |
| | Click here to see your TABINFOOPTS setting. |
| | Click here to set your TABINFOOPTS setting to YES. |
| | Click here to set your TABINFOOPTS setting to NO. |
| | Click here to view help for the SET TABINFOOPTS option. |
| | |
+---------------+------------------------------------------------------------+
| Libraries | The total number of libraries listed. |
+---------------+------------------------------------------------------------+
| Alloc | The number of libraries successfully allocated. |
+---------------+------------------------------------------------------------+
| Open | The number of libraries successfully opened. |
+---------------+------------------------------------------------------------+
| Found | The number of matches found by the WHERE subcommand. |
+---------------+------------------------------------------------------------+
| The following fields are displayed only after a WHERE subcommand: |
+---------------+------------------------------------------------------------+
| Search | The number of libraries searched by the WHERE subcommand. |
+---------------+------------------------------------------------------------+
| Member | The member name searched for by the WHERE subcommand. |
+---------------+------------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Type | The type of CLIST library. |
| | Possible values are: |
| | |
| | USER User CLIST library specified by a |
| | SET CLISTLIB command. |
| | |
| | SITE Site CLIST library specified by the |
| | Dsn-Site-CLISTLIB parameter in the |
| | System Configuration Options member. |
| | |
| | SYSTEM System CLIST library specified by the |
| | Dsn-System-CLISTLIB parameter in the |
| | System Configuration Options member. |
| | |
+---------------+------------------------------------------------------------+
| Dataset-Name | The CLIST library data set name. |
+---------------+------------------------------------------------------------+
| Volser | The volume serial number. |
+---------------+------------------------------------------------------------+
| Message | An error message, if any. |
+---------------+------------------------------------------------------------+
| The following fields are displayed only after a WHERE subcommand: |
+---------------+------------------------------------------------------------+
| VV.MM | The version and modification level of the member. |
+---------------+------------------------------------------------------------+
| Created | The date the member was created. |
+---------------+------------------------------------------------------------+
| Updated | The date the member was last modified. |
+---------------+------------------------------------------------------------+
| UpdTm | The time the member was last modified. |
+---------------+------------------------------------------------------------+
| Size | The current size of the member in number of records. |
+---------------+------------------------------------------------------------+
| User-Id | The user ID of the last ID to modify the member. |
+---------------+------------------------------------------------------------+
| Found | When a WHERE subcommand is performed with a masked member |
| | name, this is the count of how many members matched the |
| | mask within the data set. |
+---------------+------------------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Zap | Invokes the ZAP command for the data set. |
+---------------+------------------------------------------------------------+
| ZRO | Invokes the ZAP command with the READONLY option. |
+---------------+------------------------------------------------------------+
| ZRW | Invokes the ZAP command with the READWRITE option. |
+---------------+------------------------------------------------------------+

Navigation Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Browse | Invokes the BROWSE command for the data set. This is |
| | valid only when ISPF services are available. If a |
| | previous WHERE subcommand found a match in the selected |
| | data set, then the BROWSE command invoked includes the |
| | searched-for member name. |
+---------------+------------------------------------------------------------+
| DSinfo | Invokes the DSINFO command for the data set. |
| Info | |
+---------------+------------------------------------------------------------+
| Edit | Invokes the EDIT command for the data set. This is valid |
| | only when ISPF services are available. If a previous |
| | WHERE subcommand found a match in the selected data set, |
| | then the EDIT command invoked includes the searched-for |
| | member name. |
+---------------+------------------------------------------------------------+
| ENQueue | Invokes the ENQUEUE command specifying SYSDSN as the qname |
| NQ | and the selected data set name as the rname. |
+---------------+------------------------------------------------------------+
| Listdir | Invokes the LISTDIR command for the data set. If a |
| Ldir | previous WHERE subcommand found a match in the selected |
| | data set, then the LISTDIR command invoked includes the |
| | searched-for member name. |
+---------------+------------------------------------------------------------+
| View | Invokes the VIEW command for the data set. This is valid |
| | only when ISPF services are available. If a previous |
| | WHERE subcommand found a match in the selected data set, |
| | then the VIEW command invoked includes the searched-for |
| | member name. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| ALL | Invokes the LISTMDIR command with the ALL option to |
| | display all members in all libraries. |
+---------------+------------------------------------------------------------+
| CLEAR | Clears the results of a previous WHERE subcommand. |
+---------------+------------------------------------------------------------+
| DUPLICAT | Invokes the LISTMDIR command with the DUPLICAT option |
| | to display duplicate members in all libraries. Duplicate |
| | members are members that exist in more than one library. |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh the display data. |
+---------------+------------------------------------------------------------+
| UNIQUE | Invokes the LISTMDIR command with the UNIQUE option to |
| | display unique members in all libraries. Unique members |
| | are members that exist in only one library. |
+---------------+------------------------------------------------------------+
| WHERE | Searches all libraries for a specific or generic module |
| | name. |
+---------------+------------------------------------------------------------+

WHERE Subcommand

Use the WHERE subcommand to search all CLIST library data sets for a specific
or generic member and display summary information about each member found.

WHERE Subcommand Format

+---------------+------------------------------------------------------------+
| WHERE | membername |
+---------------+------------------------------------------------------------+

WHERE Parameters Explained

+---------------+------------------------------------------------------------+
| Parameter | Explanation |
+---------------+------------------------------------------------------------+
| name | The name of the member to search for. Masking characters |
| | can be used to search for a generic member name. Your |
| | mask characters are: |
| | |
| | = Variable length mask character |
| | * Fixed length mask character |
| | |
+---------------+------------------------------------------------------------+

CLEAR Subcommand

Use the CLEAR subcommand to clear the results displayed by a previous WHERE
subcommand. The CLEAR command has no parameters.

CLEAR Subcommand Format

+---------------+------------------------------------------------------------+
| CLEAR | |
+---------------+------------------------------------------------------------+

Related Information

Library concatenation - USER, SITE and SYSTEM

Messages

CLSL001I [mbr] not found

Informational only.

CLSL002E No libraries available to search

Informational only.
CLOCKMGR

CLOCKMGR Command

The CLOCKMGR command displays locks that have been defined to the
CICS lock domain. Current lock information and status of any
waiting tasks is displayed.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CLOCKMGR | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,LockName,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| LockName | Specifies the name of the lock. |
+------------------+--------------------------------------------------+
| Token | Specifies the token assigned by the lock manager |
| | to identify the lock. |
| | |
| | If the entry represents a waiting task, the |
| | token is the address of the lock manager |
| | LOCK_ELEMENT control block that represents the |
| | suspended task. |
+------------------+--------------------------------------------------+
| Owner | Specifies a token that identifies the owner of |
| | the lock. This will be blank unless a task |
| | currently holds the lock. |
+------------------+--------------------------------------------------+
| Mode | Specifies the lock mode. |
| | Possible values area: |
| | Blank - No task holds the lock. |
| | |
| | EXCL - The lock is exclusively held. |
| | The lock owner is identified in the |
| | Owner field. |
| | SHR - The lock is shared. Several tasks |
| | can hold the lock. The Owner field |
| | will be blank. |
+------------------+--------------------------------------------------+
| Count | Specifies the number of tasks that currently |
| | hold the shared lock. |
+------------------+--------------------------------------------------+
| Requests | Specifies the total number of times that the |
| | lock has been requested. |
+------------------+--------------------------------------------------+
| Suspends | Specifies the total number of tasks that have |
| | suspended when requesting this lock because the |
| | lock was held by another task. |
+------------------+--------------------------------------------------+
| Queue | Specifies the address of the first suspended |
| | task. |
+------------------+--------------------------------------------------+
| QNext | Specifies the address of the next task in the |
| | queue awaiting the lock. |
+------------------+--------------------------------------------------+
| SuspTokn | Specifies the dispatcher suspend token for the |
| | suspended task. |
+------------------+--------------------------------------------------+
| Status | Specifies the status of the suspended task. |
| | Possible values are: |
| | Blank - The task is waiting to acquire the |
| | lock. |
| | DELETED - The suspended task has been deleted |
| | from the queue. |
| | PURGED - The task was purged while waiting to |
| | acquire the lock. |
+------------------+--------------------------------------------------+
| Cell | Specifies the address of the lock manager |
| | control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Dump | Invoke the SNAP command to dump the selected |
| | lock manager cell. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CMCT

CMCT Command

The CMCT command displays a list of the fields that have been included
in the monitor control table dictionary record.

Command Syntax

+------------------+--------------------------------------------------+
| CMCT | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Module | The Monitor Control Table name. |
+------------------+--------------------------------------------------+
| Address | The address of the Monitor Control Table. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Name | The informal name. |
+------------------+--------------------------------------------------+
| Owner | The name of the owner. |
+------------------+--------------------------------------------------+
| ID | The numeric ID. |
+------------------+--------------------------------------------------+
| Type | The object type. |
+------------------+--------------------------------------------------+
| Len | The length of the object. |
+------------------+--------------------------------------------------+
| Conn | The assigned connector. |
+------------------+--------------------------------------------------+
| Offset | The assigned offset. |
+------------------+--------------------------------------------------+
Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CMDACT

CMDACT Command

The CMDACT command displays an hourly summary of SYSVIEW command


activity for the last 24 hours.

Command Syntax

+------------------+--------------------------------------------------+
| CMDACT | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Hour | The hour during which commands were issued. |
| | The "Total" line displays information since IPL. |
| | The current hour is highlighted. |
+------------------+--------------------------------------------------+
| User | The number of commands issued during the hour |
| | via a user attended or interactive interface. |
+------------------+--------------------------------------------------+
| NonUser | The number of commands issued during the hour |
| | via a non-interactive interface. |
+------------------+--------------------------------------------------+
| Count | The total number of commands issued during the |
| | hour. |
+------------------+--------------------------------------------------+
| Pct% | The percentage of the total commands issued. |
| Pctgraph | |
+------------------+--------------------------------------------------+
| Base | The number of commands issued that belong to the |
| | component: BASE |
+------------------+--------------------------------------------------+
| JES2 | The number of commands issued that belong to the |
| | component: JES2 |
+------------------+--------------------------------------------------+
| Tool | The number of commands issued that belong to the |
| | component: TOOLKIT |
+------------------+--------------------------------------------------+
| MVS | The number of commands issued that belong to the |
| | component: MVS |
+------------------+--------------------------------------------------+
| Capt | The number of commands issued that belong to the |
| | component: Event Capture |
+------------------+--------------------------------------------------+
| CICS | The number of commands issued that belong to the |
| | component: CICS |
+------------------+--------------------------------------------------+
| CTG | The number of commands issued that belong to the |
| | component: CTG |
+------------------+--------------------------------------------------+
| DB2 | The number of commands issued that belong to the |
| | component: DB2 |
+------------------+--------------------------------------------------+
| DCom | The number of commands issued that belong to the |
| | component: DATACOM |
+------------------+--------------------------------------------------+
| HChk | The number of commands issued that belong to the |
| | component: HCHECK |
+------------------+--------------------------------------------------+
| IDMS | The number of commands issued that belong to the |
| | component: IDMS |
+------------------+--------------------------------------------------+
| IMS | The number of commands issued that belong to the |
| | component: IMS |
+------------------+--------------------------------------------------+
| JVM | The number of commands issued that belong to the |
| | component: JVM |
+------------------+--------------------------------------------------+
| MIM | The number of commands issued that belong to the |
| | component: MIM |
+------------------+--------------------------------------------------+
| MQS | The number of commands issued that belong to the |
| | component: IBM MQ |
+------------------+--------------------------------------------------+
| Rosc | The number of commands issued that belong to the |
| | component: ROSCOE |
+------------------+--------------------------------------------------+
| TCP | The number of commands issued that belong to the |
| | component: TCP/IP |
+------------------+--------------------------------------------------+
| USS | The number of commands issued that belong to the |
| | component: Unix System Services |
+------------------+--------------------------------------------------+
| XSys | The number of commands issued that belong to the |
| | component: XSystem |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
CMDATTR

CMDATTR Command

The CMDATTR command sets command attributes dynamically for


the current user session. To set attributes for all user
sessions, update the parmlib member CMDATTR.

Command Syntax

+---------------+-----------------------------------------------------+
| CMDATTR | attributes |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| attributes | Specifies the attribute to be set. |
| | |
| | command:attribute[:attribute] |
| | |
| | Valid attributes are: |
| | |
| | NOZIIP - Remove zIIP eligibility for a |
| | command. |
| | DISABLED - Disable a command. |
| | |
+------------------+--------------------------------------------------+
CMDUSAGE

CMDUSAGE Command

The CMDUSAGE command displays a list of SYSVIEW commands that


have been issued by all users since the last IPL. Command usage
is separated by interface type.

Command Syntax

+------------------+--------------------------------------------------+
| CMDUSAGE | [ SUMMARY | NOSUMMARY ] |
| | [ NAVIGATE | NONAVIGATE ] |
| | [ XSDATA | NOXSDATA ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| SUMMARY | Display a summary line for each command that |
| | shows the total commands issued from |
| | interactive and non-interactive interfaces. |
| | Interactive = "*USER" |
| | Non-interactive = "*NONUSER" |
+------------------+--------------------------------------------------+
| NOSUMMARY | Do not display summary line. |
+------------------+--------------------------------------------------+
| NAVIGATE | Display all commands. |
+------------------+--------------------------------------------------+
| NONAVIGATE | Do not display commands that are associated |
| | with screen navigation. |
| | Examples: UP, DOWN, TOP, BOTTOM, RIGHT, LEFT |
+------------------+--------------------------------------------------+
| XSDATA | Specifies that data from all connect systems |
| | is to be displayed. |
| | This forces cross system data collection to be |
| | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSDATA | Specifies that only data from the current system |
| | is to be displayed. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+

Information Fields

The values displayed in the information section are for the local
system.

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Options | Lists the current effective command options. |
+------------------+--------------------------------------------------+
| Total | The total number of commands issued by all |
| | interface types. |
+------------------+--------------------------------------------------+
| Interactive | The total number of commands issued by |
| | interactive interfaces. |
+------------------+--------------------------------------------------+
| NonInteractive | The total number of commands issued by |
| | non-interactive interfaces. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Command | Command name |
+------------------+--------------------------------------------------+
| SubCmd | Subcommand name |
+------------------+--------------------------------------------------+
| Interface | Interface type |
+------------------+--------------------------------------------------+
| Count | The number of times that the command or |
| | subcommand has been issued. |
+------------------+--------------------------------------------------+
| Pct% | The percentage of the total commands issued, |
| Pctgraph | based on whether the interface type belongs to |
| | the interactive or non-interactive category as |
| | indicated in the Intr field. |
| | |
| | The bar graph for an interactive interface will |
| | be displayed using screen attribute BARGRAPH. |
| | |
| | The bar graph for a non-interactive interface |
| | will be displayed using screen attribute |
| | BARGRAPHHI. |
+------------------+--------------------------------------------------+
| Comp | The owning command component. |
+------------------+--------------------------------------------------+
| Description | The description of the command. |
+------------------+--------------------------------------------------+
| LastUser | The last userid to issue the command. |
+------------------+--------------------------------------------------+
| LastDate | The date and time that the command was last |
| LastTime | issued. |
+------------------+--------------------------------------------------+
| Elapsed | The elapsed interval since the command was last |
| | used. |
+------------------+--------------------------------------------------+
| Intr | Indicates the interface type is interactive. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands
No line commands are defined by the &HelpMember command, however
other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
CMODES

CMODES Command

The CMODES command displays information about a session group


within a connection.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CMODES | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Modename,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| SysID | The SysID defined to the remote connection. |
| | This is also referred to as the connection name. |
+------------------+--------------------------------------------------+
| Modename | The mode group name. |
+------------------+--------------------------------------------------+
| Connect | Automatic connection status whenever CICS |
| | starts a connection with VTAM. |
| | |
| | Possible values are: |
| | |
| | AUTO - CICS tries to bind only sessions |
| | for which it is contention winner |
| | ALLCONN - CICS tries to bind both connection |
| | winner and loser sessions |
| | NOAUTO - CICS does not try to bind any |
| | sessions |
+------------------+--------------------------------------------------+
| Active | The number of sessions currently in use. |
| | Source: DFHTCTME.TCMEMCON |
+------------------+--------------------------------------------------+
| Avail | The current number of sessions bound. |
| | This field can be modified. |
| | Source: DFHTCTME.TCMEMAXS |
+------------------+--------------------------------------------------+
| Max | The maximum number of sessions defined in the |
| | mode group. |
| | Source: DFHTCTME.TCMELMAX |
+------------------+--------------------------------------------------+
| Winners | The number of winners (secondaries) with tasks. |
| | Source: DFHTCTME.TCME2RY |
+------------------+--------------------------------------------------+
| Losers | The number of losers (primaries) with tasks. |
| | Source: DFHTCTME.TCME1RY |
+------------------+--------------------------------------------------+
| Bound | Number of currently bound sessions |
| | Source: DFHTCTME.TCMEBND |
+------------------+--------------------------------------------------+
| AllocTot | Number of allocates for LINK |
| | Source: DFHTCTME.TCMESTAS |
+------------------+--------------------------------------------------+
| AllocQue | Number of allocated queued |
| | Source: DFHTCTME.TCMESTAQ |
+------------------+--------------------------------------------------+
| AllocMax | Maximum number of allocates outstanding |
| | Source: DFHTCTME.TCMESTAM |
+------------------+--------------------------------------------------+
| AllocGen | Number of generic allocates satisfied |
| | Source: DFHTCTME.TCMESTAG |
+------------------+--------------------------------------------------+
| AllocSpe | Number of specific allocates satisfied |
| | Source: DFHTCTME.TCMESTAP |
+------------------+--------------------------------------------------+
| FailLink | Number of allocates failing - LINK SHUT |
| | Source: DFHTCTME.TCMESTAF |
+------------------+--------------------------------------------------+
| FailOthr | Number of allocated failing - OTHER |
| | Source: DFHTCTME.TCMESTAO |
+------------------+--------------------------------------------------+
| Bids | Number of BIDS in progress |
| | Source: DFHTCTME.TCMEBID |
+------------------+--------------------------------------------------+
| BidSent | Number of BIDS sent |
| | Source: DFHTCTME.TCMESBID |
+------------------+--------------------------------------------------+
| BidPri | Maximum number of BIDS |
| | Source: DFHTCTME.TCMEBHWM |
+------------------+--------------------------------------------------+
| BidSec | LUC maximum number of winners |
| | Source: DFHTCTME.TCME2HWM |
+------------------+--------------------------------------------------+
| ATIs1 | LUC ATIs satisfied by winners |
| | Source: DFHTCTME.TCMES1 |
+------------------+--------------------------------------------------+
| ATIs2 | LUC ATIs satisfied by losers |
| | Source: DFHTCTME.TCMES2 |
+------------------+--------------------------------------------------+
| PeakLose | Peak contention losers |
| | Source: DFHTCTME.TCME1HWM |
+------------------+--------------------------------------------------+
| CNOSWin | Current CNOS negotiated contention winners |
| | Source: DFHTCTME.TCMECONW |
+------------------+--------------------------------------------------+
| CNOSLose | Current CNOS negotiated contention losers |
| | Source: DFHTCTME.TCMECONL |
+------------------+--------------------------------------------------+
| DFHTCTSE | The address of the DFHTCTSE control block |
+------------------+--------------------------------------------------+
| DFHTCTME | The address of the DFHTCTME control block |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CMODS

CMODS Command

The CMODS display provides information and status for SYSVIEW


CICS Data Collection modules.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CMODS | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Module,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Module | Module name |
+------------------+--------------------------------------------------+
| Epaddr | Entry point address |
+------------------+--------------------------------------------------+
| Size | Module size |
+------------------+--------------------------------------------------+
| Count | Module use count |
+------------------+--------------------------------------------------+
| Rels | The release of the module |
+------------------+--------------------------------------------------+
| Build | The build number of the module |
+------------------+--------------------------------------------------+
| FixLevel | The module fix level |
+------------------+--------------------------------------------------+
| Date | The assembly date of the module |
+------------------+--------------------------------------------------+
| Time | The assembly time of the module |
+------------------+--------------------------------------------------+
| MacLv | The macro level used when assembling the module |
+------------------+--------------------------------------------------+
| AsmUser | The user id that assembled the module |
+------------------+--------------------------------------------------+
| Owner | The user id that owns the module |
+------------------+--------------------------------------------------+
XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Dump | Invoke the DUMP command to display the storage |
| | at the entry point address of the module. |
+------------------+--------------------------------------------------+

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CMONITOR

CMONITOR Command

The CMONITOR command displays information about the Monitor Domain.


The status of monitoring options and monitor record information is
displayed.

Command Syntax

+------------------+--------------------------------------------------+
| CMONITOR | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Monitor | The status of CICS monitoring. |
+------------------+--------------------------------------------------+
| Exception | Specifies if the CICS exception class of data is |
| | to be collected. |
+------------------+--------------------------------------------------+
| Performance | Specifies if the CICS performance class of data |
| | is to be collected. |
+------------------+--------------------------------------------------+
| SYSEVENT | Specifies if the CICS SYSEVENT class of data is |
| | to be collected. |
+------------------+--------------------------------------------------+
| UserExit | Specifies if a user exit is active for the |
| | global user exit XMNOUT. |
+------------------+--------------------------------------------------+
| CPUtime | Specifies if CPU time collection is active. |
+------------------+--------------------------------------------------+
| Conversational | Specifies if monitor records are logged for each |
| | send/receive pair. |
+------------------+--------------------------------------------------+
| Syncpoint | Specifies if monitor records are logged for each |
| | explicit or implicit syncpoint (unit-of-work). |
+------------------+--------------------------------------------------+
| Freq | The CICS monitoring frequency interval. CICS |
| | automatically produces a transaction performance |
| | class record for any long-running transaction. |
| | |
| | Valid values are: |
| | 0 - No frequency monitoring is active |
| | hh:mm:ss - Frequence interval |
+------------------+--------------------------------------------------+
| Compress | Specifies if monitor data is to be compressed. |
+------------------+--------------------------------------------------+
| Resource | Specifies if the transaction resource class |
| | of monitoring data is being collected. |
+------------------+--------------------------------------------------+
| Applname | Specifies if CICS application naming support |
| | is enabled. |
+------------------+--------------------------------------------------+
| Time | Specifies whether the time stamps in the |
| | performance class records are in GMT or Local |
| | time |
+------------------+--------------------------------------------------+
| RMI | Specifies if the additional data is to be |
| | collected for resource managers |
+------------------+--------------------------------------------------+
| TSQueueLimit | The maximum number of tempory storage queues that|
| | will be collected by the transaction resource |
| | monitor |
+------------------+--------------------------------------------------+
| FileLimit | The maximum number of files that will be |
| | collected by the transaction resource monitor |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Record-Type | The CICS record type. |
+------------------+--------------------------------------------------+
| Records | The number of records written. |
+------------------+--------------------------------------------------+
| Suppressed | The number of records suppressed. |
+------------------+--------------------------------------------------+
| Errors | The number of bad responses from SMF. |
+------------------+--------------------------------------------------+
| Retries | The number of retries. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Related Information

The following links can be selected to turn monitoring ON or OFF:

Set CICS conversational monitoring on


Set CICS conversational monitoring off
CMONSTAT

CMONSTAT Command

The CMONSTAT command displays status information for the CICS monitor
domain. The SYSTEM and XSYSTEM options allow for comparison of
settings on multiple CICS regions.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CMONSTAT | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| MN | The current CICS monitoring status. |
| | SIT parameter: MN |
+------------------+--------------------------------------------------+
| CMN | The desired CICS monitor state. |
| | SIT parameter: MN |
| | |
| | If MN=ON and CMN=OFF, SMF 110 performance |
| | records will be suppressed. |
| | |
| | If the fields MN and CMN do not match, |
| | the CMN field will be displayed with a |
| | highlighted status. |
+------------------+--------------------------------------------------+
| MNPER | The current CICS performance monitoring status. |
| | SIT parameter: MNPER |
+------------------+--------------------------------------------------+
| CMNPER | The desired CICS monitor performance state. |
| | SIT parameter: MNPER |
| | |
| | If MNPER=ON and CMNPER=OFF, SMF 110 performance |
| | records will be suppressed. |
| | |
| | If the fields MNPER and CMNPER do not match, |
| | the CMNPER field will be displayed with a |
| | highlighted status. |
+------------------+--------------------------------------------------+
| MNEXC | The current CICS exception monitoring status. |
| | SIT parameter: MNEXC |
+------------------+--------------------------------------------------+
| CMNEXC | The desired CICS monitor exception state. |
| | SIT parameter: MNEXC |
| | |
| | If MNEXC=ON and CMNEXC=OFF, SMF 110 exception |
| | records will be suppressed. |
| | |
| | If the fields MNEXC and CMNEXC do not match, |
| | the CMNEXC field will be displayed with a |
| | highlighted status. |
+------------------+--------------------------------------------------+
| MNRES | The current CICS resource monitoring status. |
| | SIT parameter: MNRES |
+------------------+--------------------------------------------------+
| CMNRES | The desired CICS monitor resource state. |
| | SIT parameter: MNRES |
| | |
| | If MNRES=ON and CMNRES=OFF, SMF 110 resource |
| | records will be suppressed. |
| | |
| | If the fields MNRES and CMNRES do not match, |
| | the CMNRES field will be displayed with a |
| | highlighted status. |
+------------------+--------------------------------------------------+
| MNCONV | The current CICS conversational performance |
| | class monitoring status. |
| | SIT parameter: MNCONV |
+------------------+--------------------------------------------------+
| CMNCONV | The desired CICS monitor conversational state. |
| | SIT parameter: MNCONV |
| | |
| | If the fields MNCONV and CMNCONV do not match, |
| | the CMNCONV field will be displayed with a |
| | highlighted status. |
+------------------+--------------------------------------------------+
| MNIDN | The current CICS identity monitoring status. |
| | SIT parameter: MNIDN |
+------------------+--------------------------------------------------+
| MNSYNC | The current CICS syncpoint monitoring status. |
| | SIT parameter: MNSYNC |
+------------------+--------------------------------------------------+
| MNFREQ | The current CICS frequency monitoring interval. |
| | SIT parameter: MNFREQ |
+------------------+--------------------------------------------------+
| MNTIME | Indicate whether CICS performance class records |
| | use GMT or LOCAL time values. |
| | SIT parameter: MNTIME |
+------------------+--------------------------------------------------+
| RMI | Resource manager data collection status. |
| | DFHMCT parameter: RMI |
+------------------+--------------------------------------------------+
| DPL | The current CICS resource monitoring for |
| | distributed program links limit. |
| | DFHMCT parameter: DPL |
+------------------+--------------------------------------------------+
| CDPL | The desired CICS resource monitoring for |
| | distributed program links limit. |
| | DFHMCT parameter: DPL |
| | |
| | If the fields DPL and CDPL do not match, |
| | the CDPL field will be displayed with a |
| | highlighted status. |
+------------------+--------------------------------------------------+
| File | The current CICS resource monitoring for files |
| | limit. |
| | DFHMCT parameter: FILE |
+------------------+--------------------------------------------------+
| CFile | The desired CICS resource monitoring for files |
| | limit. |
| | DFHMCT parameter: FILE |
| | |
| | If the fields File and CFile do not match, |
| | the CFile field will be displayed with a |
| | highlighted status. |
+------------------+--------------------------------------------------+
| TSQ | The current CICS resource monitoring for |
| | temporary storage queues limit. |
| | DFHMCT parameter: TSQUEUE |
+------------------+--------------------------------------------------+
| CTSQ | The desired CICS resource monitoring for |
| | temporary storage queues limit. |
| | DFHMCT parameter: TSQUEUE |
| | |
| | If the fields TSQ and CTSQ do not match, |
| | the CTSQ field will be displayed with a |
| | highlighted status. |
+------------------+--------------------------------------------------+
| URIMAP | The current CICS resource monitoring for URIMAPs |
| | limit. |
| | DFHMCT parameter: URIMAP |
| | Requires CICS TS 5.5 or higher |
+------------------+--------------------------------------------------+
| CURIMAP | The desired CICS resource monitoring for URIMAPs |
| | limit. |
| | DFHMCT parameter: URIMAP |
| | Requires CICS TS 5.5 or higher |
| | |
| | If the fields URIMAP and CURIMAP do not match, |
| | the CURIMAP field will be displayed with a |
| | highlighted status. |
+------------------+--------------------------------------------------+
| WebSvc | The current CICS resource monitoring for web |
| | services limit. |
| | DFHMCT parameter: WEBSERVC |
| | Requires CICS TS 5.5 or higher |
+------------------+--------------------------------------------------+
| CWebSvc | The desired CICS resource monitoring for web |
| | services limit. |
| | DFHMCT parameter: WEBSERVC |
| | Requires CICS TS 5.5 or higher |
| | |
| | If the fields WebSvc and CWebSvc do not match, |
| | the CWebSvc field will be displayed with a |
| | highlighted status. |
+------------------+--------------------------------------------------+
| XMNOUT | Indicates if a user exit is active for the |
| | CICS global user exit XMNOUT. |
+------------------+--------------------------------------------------+
| SYSEVENT | The CICS SYSEVENT class monitoring status. |
+------------------+--------------------------------------------------+
| CPU | CPU collection status |
+------------------+--------------------------------------------------+
| Compress | The current CICS monitoring data compression |
| | status. |
| | DFHMCT parameter: COMPRESS |
+------------------+--------------------------------------------------+
| Applname | The CICS application naming support status. |
| | DFHMCT parameter: APPLNAME |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined


by the RXDISP.&HelpMember command. Other types of
line commands are also available. Follow the links
below for more information.

Special Line Commands


External Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Related Information

Configuration settings in the SYSVIEW for CICS data collector can


affect the current CICS monitoring statuses. For more information
see CICS Monitor Activation.
CMQCONN

CMQCONN Command

The CMQCONN command can be used to display details about the


current connection between IBM MQ and CICS.

Command Syntax

+------------------+--------------------------------------------------+
| CMQCONN | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| InitQ | The name of the default initiation queue. |
+------------------+--------------------------------------------------+
| QMgr | The name of the queue manager for the connection.|
+------------------+--------------------------------------------------+
| Tracing | Specifies if tracing is active. |
+------------------+--------------------------------------------------+
| APIExit | Specifies if the API-crossing exit is enabled. |
+------------------+--------------------------------------------------+
| Status | Specifies the current connection status. |
| | Possible values are: |
| | |
| | CONNECTED - The connection has been made.|
| | |
| | CONNECTING - The CICS subsystem is in the |
| | process of connecting to |
| | the queue manager. |
| | |
| | DISCONNECTED - The connection has |
| | terminated. |
| | |
| | INACTIVE - A request was made to |
| | connect to a queue manager |
| | but has failed. |
| | |
| | QUIESCING - The connection is processing |
| | a quiesced shutdown. |
| | |
| | PENDING - A connection request has been|
| | deferred because the queue |
| | manager is not running. |
| | |
| | STOPPING-FORCE - The connection is processing |
| | a forced shutdown. |
| | |
+------------------+--------------------------------------------------+

Data Fields

Statistics
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| In-Flight Tasks | Current number of in-flight tasks |
+------------------+--------------------------------------------------+
| Running CKTI | Current number of the running CKTI transactions |
+------------------+--------------------------------------------------+
| Total API Calls | Total number of API calls made |
+------------------+--------------------------------------------------+

API Analysis
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Run OK | Total number of API calls that completed okay |
+------------------+--------------------------------------------------+
| Futile | Number of futile attempts. This is the number |
| | of API calls issued when the previous call got a |
| | return code showing that the connection had |
| | ended. |
+------------------+--------------------------------------------------+
| MQOPEN | Total number of OPEN API calls |
+------------------+--------------------------------------------------+
| MQCLOSE | Total number of CLOSE API calls |
+------------------+--------------------------------------------------+
| MQGET | Total number of GET API calls |
+------------------+--------------------------------------------------+
| GETWAIT | Total number of GET API calls with the WAIT |
| | option. |
+------------------+--------------------------------------------------+
| MQPUT | Total number of PUT API calls |
+------------------+--------------------------------------------------+
| MQPUT1 | Total number of PUT1 API calls |
+------------------+--------------------------------------------------+
| MQINQ | Total number of INQ API calls |
+------------------+--------------------------------------------------+
| MQSET | Total number of SET API class |
+------------------+--------------------------------------------------+

Flows
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Calls | Total number of flows |
+------------------+--------------------------------------------------+
| SyncComp | Total number of calls that sync complete |
+------------------+--------------------------------------------------+
| SuspReqd | Total number of calls that needed I/O |
+------------------+--------------------------------------------------+
| MsgWait | Total number of real GETWAIT calls |
+------------------+--------------------------------------------------+
| Switch | Total number of calls switched |
+------------------+--------------------------------------------------+

SyncPoint
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Tasks | Total number of tasks |
+------------------+--------------------------------------------------+
| Backout | Total number of backout UOWs |
+------------------+--------------------------------------------------+
| Commit | Total number of committed UOWs |
+------------------+--------------------------------------------------+
| Single | Total number of single phase commits |
+------------------+--------------------------------------------------+
| 2-Phase | Total number of 2 phase commits |
+------------------+--------------------------------------------------+

Recovery
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Indoubt | Count of indoubt units of work |
+------------------+--------------------------------------------------+
| UnResolve | Count of unresolved units of work |
+------------------+--------------------------------------------------+
| Commit | Count of resolved committed UOWs |
+------------------+--------------------------------------------------+
| Backout | Count of resolved backout UOWs |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CMQMON

CMQMON Command

The CMQMON command displays the attributes of defined MQMONITOR


resources.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CMQMON | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Name,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Name | MQMonitor resource definition name. |
+------------------+--------------------------------------------------+
| AutoStart | Auto start status |
| | Possible values are: |
| | |
| | AUTOSTART |
| | NOAUTOSTART |
+------------------+--------------------------------------------------+
| EnableStatus | Enable status |
| | Possible values are: |
| | |
| | ENABLED |
| | ENABLING |
| | DISABLING |
| | DISCARDING |
| | DISABLED |
+------------------+--------------------------------------------------+
| MonStatus | Monitor status |
| | Possible values are: |
| | |
| | STARTED |
| | STARTING |
| | STOPPING |
| | STOPPED |
+------------------+--------------------------------------------------+
| Tran | Transaction ID |
+------------------+--------------------------------------------------+
| Task | Task ID |
+------------------+--------------------------------------------------+
| QName | Queue name |
+------------------+--------------------------------------------------+
| MonUser | Userid of trigger monitor |
+------------------+--------------------------------------------------+
| Userid | Userid of started task |
+------------------+--------------------------------------------------+
| Qmgr | Name of the Qmgr in the MQ connection |
+------------------+--------------------------------------------------+
| ConnectStatus | Status of the MQ connection |
| | Possible values are: |
| | |
| | CONNECTED - The connection has been made.|
| | |
| | CONNECTING - The CICS subsystem is in the |
| | process of connecting to |
| | the queue manager. |
| | |
| | DISCONNECTED - The connection has |
| | terminated. |
| | |
| | INACTIVE - A request was made to |
| | connect to a queue manager |
| | but has failed. |
| | |
| | QUIESCING - The connection is processing |
| | a quiesced shutdown. |
| | |
| | PENDING - A connection request has been|
| | deferred because the queue |
| | manager is not running. |
| | |
| | STOPPING-FORCE - The connection is processing |
| | a forced shutdown. |
+------------------+--------------------------------------------------+
| OPEN | Number of OPEN requests |
+------------------+--------------------------------------------------+
| CLOSE | Number of CLOSE requests |
+------------------+--------------------------------------------------+
| GET | Number of GET requests |
+------------------+--------------------------------------------------+
| GETWAIT | Number of GETWAIT requests |
+------------------+--------------------------------------------------+
| PUT | Number of PUT requests |
+------------------+--------------------------------------------------+
| PUT1 | Number of PUT1 requests |
+------------------+--------------------------------------------------+
| INQ | Number of INQ requests |
+------------------+--------------------------------------------------+
| INQL | Number of INQL requests |
+------------------+--------------------------------------------------+
| SET | Number of SET requests |
+------------------+--------------------------------------------------+
| COMMIT | Number of COMMIT requests |
+------------------+--------------------------------------------------+
| BACKOUT | Number of BACKOUT requests |
+------------------+--------------------------------------------------+
| OTHER | Number of other requests |
+------------------+--------------------------------------------------+
| StartDate | Monitor start date |
+------------------+--------------------------------------------------+
| StartTime | Monitor start time |
+------------------+--------------------------------------------------+
| StopDate | Monitor stop date |
+------------------+--------------------------------------------------+
| StopTime | Monitor stop time |
+------------------+--------------------------------------------------+
| MonitorData | Data passed to monitor |
+------------------+--------------------------------------------------+
| DefGroup | Definition group |
+------------------+--------------------------------------------------+
| DFHMQMNT | DFHMQMNT control block |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| AUTo | Issue an AUTOSTART request for the selected |
| | MQMONITOR name. |
| | |
| | Command issued: CICSSET MQMON name AUTOSTART |
+------------------+--------------------------------------------------+
| DISabled | Issue an DISABLE request for the selected |
| | MQMONITOR name. |
| | |
| | Command issued: CICSSET MQMON name DISABLED |
+------------------+--------------------------------------------------+
| ENAbled | Issue an ENABLE request for the selected |
| | MQMONITOR name. |
| | |
| | Command issued: CICSSET MQMON name ENABLED |
+------------------+--------------------------------------------------+
| NOAuto | Issue an NOAUTOSTART request for the selected |
| | MQMONITOR name. |
| | |
| | Command issued: CICSSET MQMON name NOAUTOSTART |
+------------------+--------------------------------------------------+
| QUeue | Issue an MQQLOCAL command to display the |
| | initiation queue as well as any applications |
| | queues defined to trigger to the initiation |
| | queue. |
+------------------+--------------------------------------------------+
| STArted | Issue an START request for the selected |
| | MQMONITOR name. |
| | |
| | Command issued: CICSSET MQMON name STARTED |
+------------------+--------------------------------------------------+
| STOpped | Issue an STOP request for the selected |
| | MQMONITOR name. |
| | |
| | Command issued: CICSSET MQMON name STOPPED |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CMQTASKS

CMQTASKS Command

The CMQTASKS command can be used to display information about the


tasks that are using the IBM MQ, CICS to queue manager connection.

Command Syntax

+------------------+--------------------------------------------------+
| CMQTASKS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Tran | Specifies the CICS transaction ID. |
+------------------+--------------------------------------------------+
| Task# | Specifies the CICS task number.. |
+------------------+--------------------------------------------------+
| Userid | Specifies the user ID associated with the task |
+------------------+--------------------------------------------------+
| TaskStatus | Specifies the status of the task. |
| | Possible values are: |
| | NORMAL |
| | FORCE-TERM |
+------------------+--------------------------------------------------+
| ThreadStatus | Specifies the status of the call. |
+------------------+--------------------------------------------------+
| LastAPI | Shows the last API call made by the task. |
+------------------+--------------------------------------------------+
| Calls | Total number of API calls made by the task. |
+------------------+--------------------------------------------------+
| Initiation-Queue | Name of the initiation queue. |
+------------------+--------------------------------------------------+
| APIExit | Indicates whether the task is running in the |
| | API exit. |
+------------------+--------------------------------------------------+
| QExit | Indicates whether the task is running in the |
| | selection queue exit. |
+------------------+--------------------------------------------------+
| Conv | Indicates whether the task is running in the |
| | data conversion exit. |
+------------------+--------------------------------------------------+
| ResSec | Indicates whether CICS resource security check |
| | is active for the transaction. |
+------------------+--------------------------------------------------+
| CLOT | Specifies the address of the CLOT control block. |
| | This is also the thread ID assigned to the task |
| | by the CICS adapter. |
+------------------+--------------------------------------------------+
| CTHD | Specifies the address of the CTHD control block. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
COLS

COLS Command

The COLS command turns the column scale ruler on or off on the current display.

Command Syntax

+---------------+------------------------------------------------------------+
| COLS | [toggle] |
+---------------+------------------------------------------------------------+

Parameters

+------------------------------------------------------------+
| Use one toggle (Optional) |
+------------------------------------------------------------+
| ON |
| OFf |
+------------------------------------------------------------+

Toggle Parameter Values Explained

+----------------+-----------------------------------------------------------+
| Toggle Value | Explanation |
+----------------+-----------------------------------------------------------+
| ON | Turns the column scale ruler on. This is the same as the |
| | SET COLUMNS ON command. |
+----------------+-----------------------------------------------------------+
| OFf | Turns the column scale ruler off. This is the same as |
| | the SET COLUMNS OFF command. |
+----------------+-----------------------------------------------------------+

Notes

The following notes explain how to use certain features of the COLS command:

* If you enter no parameter with COLS, then the current COLS setting is
reversed.

* The COLS command affects only the display where it is entered.


COMMANDS

COMMANDS Command

The COMMANDS command displays SYSVIEW command and subcommand


information.

Command Syntax

+------------------+--------------------------------------------------+
| COMMANDS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Command | Primary or function command name. |
+------------------+--------------------------------------------------+
| SubCmd | Subcommand name. |
+------------------+--------------------------------------------------+
| Description | Description. |
+------------------+--------------------------------------------------+
| Feature | The name of the product feature that this |
| | command is a part of. |
+------------------+--------------------------------------------------+
| Type | The type of command. Values can be |
| | |
| | PRI Primary command |
| | SUB Subcommand |
| | FUNC Function command |
| | |
+------------------+--------------------------------------------------+
| Rels | The release at which the command was introduced. |
+------------------+--------------------------------------------------+
| Essentials | ESSENTIALS if the command is included as part |
| | of SYSVIEW Essentials. |
+------------------+--------------------------------------------------+
| Count | The command execution count. |
| | A REFRESH subcommand is included in this count |
| | and not as a separate subcommand. |
+------------------+--------------------------------------------------+
| Refresh | The number of times the command was refreshed. |
+------------------+--------------------------------------------------+
| System | SYSTEM if the command displays information |
| | by gathering data from multiple regions or |
| | subsystems for the current system. |
+------------------+--------------------------------------------------+
| XSystem | XSYSTEM if the command supports cross system |
| | data gathering and display. |
+------------------+--------------------------------------------------+
| XDI | XDI if the command is eligible to execute under |
| | the eXternal Data Interface (XDI). |
+------------------+--------------------------------------------------+
| New | NEW if the command is a new command for the |
| | current release. |
+------------------+--------------------------------------------------+
| JES | JES if the command supports both JES2 and JES3, |
| | JES2 if the command supports just JES2, and |
| | JES3 if the command supports just JES3. |
| | Otherwise blank. |
+------------------+--------------------------------------------------+
| OSMin | The minimum operating system level required |
| | to execute the command. The value is displayed |
| | using the SPLevel format: SPx.x.x |
| | |
| | If the OSMin value is blank, there is no |
| | minimum requirement. |
+------------------+--------------------------------------------------+
| OSMax | The maximum operating system level required |
| | to execute the command. The value is displayed |
| | using the SPLevel format: SPx.x.x |
| | |
| | If the OSMax value is blank, there is no |
| | maximum requirement. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Fields | Invoke the FIELDS command to display a list of fields |
| | for the selected command. |
+----------+----------------------------------------------------------+
| FORmats | Invoke the PROFILE FORMATS section for the selected |
| | command. |
+----------+----------------------------------------------------------+
| Help | Invokes the HELP command for the selected command. |
+----------+----------------------------------------------------------+
| LC | Invokes the LISTLCMD command to display a list of |
| | available line commands. |
+----------+----------------------------------------------------------+
| Menu | Lists the menus on which the command appears. |
+----------+----------------------------------------------------------+
| MISc | Invoke the PROFILE MISCELLANEOUS section for the |
| | selected command. |
+----------+----------------------------------------------------------+
| PFKeys | Invoke the PROFILE PFKEYS section for the selected |
| | command. |
+----------+----------------------------------------------------------+
| PRInt | Prints the help topic for the selected command. This |
| | line command is ignored if entered for a subcommand. |
| | |
| | The following command controls the number of |
| | lines per page: |
| | |
| | SET PRINTLINect nnn |
+----------+----------------------------------------------------------+
| PROfile | Invokes the PROFILE command for the selected command. |
+----------+----------------------------------------------------------+
| Select | Selects the command for execution. |
+----------+----------------------------------------------------------+
| SYNonyms | Invoke the PROFILE SYNONYMS section for the selected |
| | command. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFresh | Refresh display data. |
+----------+----------------------------------------------------------+
| OPTions | Set and display COMMANDS command processing options. |
+----------+----------------------------------------------------------+

OPTIONS Subcommand

The OPTIONS subcommand is used to set and display COMMANDS command


processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [optns] |
+---------------+-----------------------------------------------------+

The following table lists and explains the valid OPTIONS


parameter values. Any number of the values can be specified
in any order. The current settings of all options are always
displayed in response to the OPTIONS subcommand.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| Subcmd | Controls whether or not subcommands are displayed |
| NOSubcmd | in addition to primary and function commands. |
| | The default is SUBCMD. |
+---------------+-----------------------------------------------------+
| Refresh | Controls whether or not the REFRESH subcommand is |
| NORefresh | displayed. The default is NOREFRESH. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updates is named |
| | SYSV_OPTIONS_COMMANDS. This keyword is only |
| | valid when the product is running under a TSO CLIST |
| | or REXX EXEC. EXTRACT can be specified alone or in |
| | combination with any other OPTIONS keywords. |
+---------------+-----------------------------------------------------+
COMMENT

COMMENT Command

The COMMENT command is a dummy command that performs no operation.

Command Syntax

+---------------+------------------------------------------------------------+
| COMMENT | [anyparm] |
+---------------+------------------------------------------------------------+

Parameters

+----------------+-----------------------------------------------------------+
| Parameter | Explanation |
+----------------+-----------------------------------------------------------+
| anyparm | Any sequence of characters except command delimiter |
| | characters. |
+----------------+-----------------------------------------------------------+
COMMON

COMMON Command

The COMMON command displays information about common storage.


Several display formats are available that enable you to:

* View a summary of common storage by using the SUMMARY keyword

* Display allocated common storage in detail with the ALLOC keyword

* Display in-use common storage in detail with the INUSE keyword

* Display unallocated common storage in detail with the UNALLOC keyword

Command Syntax

+---------------+------------------------------------------------------------+
| COMMON | Summary |
| | BElow |
| | ABove |
| | Alloc[,type][,spn][,key][,loc] |
| | Inuse[,type][,spn][,key][,loc] |
| | UNalloc[,loc] |
| | List |
+---------------+------------------------------------------------------------+

Parameters

+---------------+------------------------------------------------------------+
| Parameter | Explanation |
+---------------+------------------------------------------------------------+
| Summary | Displays a summary of all allocated common storage. This |
| | is the default. |
+---------------+------------------------------------------------------------+
| BElow | Displays a summary of common storage allocated below |
| | 16 MB. |
+---------------+------------------------------------------------------------+
| ABove | Displays a summary of common storage allocated above |
| | 16 MB. |
+---------------+------------------------------------------------------------+
| Alloc | Displays the allocated common storage screen. |
+---------------+------------------------------------------------------------+
| Inuse | Displays the in-use common storage screen. |
+---------------+------------------------------------------------------------+
| UNalloc | Displays the unallocated common storage screen. |
+---------------+------------------------------------------------------------+
| List | Displays a list of common storage data. |
+---------------+------------------------------------------------------------+
| type | The storage type to display. Valid values are: |
| | |
| | ALL Display all common storage. This is the |
| | default. |
| | CSA Display only CSA storage |
| | SQA Display only SQA storage |
+---------------+------------------------------------------------------------+
| spn | The subpool to display. Valid values are: |
| | |
| | ALL Display all subpools. This is the default. |
| | NNN A valid common storage subpool number specified |
| | as a decimal number from 0 to 255 |
+---------------+------------------------------------------------------------+
| key | The storage key to display. Valid values are: |
| | |
| | ALL Display all storage keys. This is the default. |
| | Z Display only key 0 storage |
| | NZ Display only non-key 0 storage (keys 1 to 15) |
| | USR Display user keys (keys 8 to 15) |
| | SYS Display system keys (keys 0 to 7) |
| | NNN Display a specific storage key (0 to 15) |
+---------------+------------------------------------------------------------+
| loc | The locations to display. Valid values are: |
| | |
| | ALL Display all locations |
| | ANY Display all locations (same as ALL) |
| | BELOW Display storage below 16 MB |
| | ABOVE Display storage above 16 MB |
+---------------+------------------------------------------------------------+

Information Fields

+-----------------+----------------------------------------------------------+
| Field | Description |
+-----------------+----------------------------------------------------------+
| AllowUserKeyCSA | Indicates if user key CSA is permitted. If NO, |
| | requestors will be abended, |
+-----------------+----------------------------------------------------------+
| RUCSA | Indicates the status of the Restricted Use Common |
| | Service Area (RUCSA). |
| | |
| | Possible values are: |
| | |
| | NONE - Support is not enabled |
| | SUPPORTED - Support is available on the system |
| | DEFINED - Support is available and defined |
| | |
+-----------------+----------------------------------------------------------+
| Region | The region name. |
+-----------------+----------------------------------------------------------+
| ASize | The size of the region. ASize is displayed when the |
| or | ADJCNVT option has been set with the OPTIONS subcommand |
| Size | and Size is displayed for NOADJCNVT. |
| | |
| | Field status is based on current threshold setting. |
| | Region: CSA, E-CSA, SQA, E-SQA, RUCSA, E-RUCSA |
+-----------------+----------------------------------------------------------+
| UnAlloc/Large | The total amount of unallocated storage in the region |
| | and the size of the largest block of unallocated storage.|
| | |
| | Field status is based on current threshold setting. |
| | Region: CSA, E-CSA, RUCSA, E-RUCSA |
+-----------------+----------------------------------------------------------+
| Alloc/Pct% | The amount and percent of the region allocated. |
+------------------+---------------------------------------------------------+-
| Used/Pct% | The amount and percent of the region in use. |
| | |
| | Field status is based on current threshold setting. |
| | Region: CSA, E-CSA, SQA, E-SQA, RUCSA, E-RUCSA |
+-----------------+----------------------------------------------------------+
| Free | The amount of the region allocated but not in use. |
| | |
| | Field status is based on current threshold setting. |
| | Region: SQA, E-SQA |
+-----------------+----------------------------------------------------------+
| Cnvrt | The amount of CSA or E-CSA converted to SQA or E-SQA. |
| | This value displays as negative for CSA and E-CSA and a |
| | positive for SQA and E-SQA. |
| | |
| | Field status is based on current threshold setting. |
| | Region: CSA, E-CSA |
+-----------------+----------------------------------------------------------+
| HWM/Pct% | The high water mark for the Used/Pct% field. |
+-----------------+----------------------------------------------------------+

Data Fields

The following fields are available on the SUMMARY screen:


Type, Spn, Key, Total

The following fields are available on the ALLOC screen:


Type, Spn, Key, A-Addr, A-Byt, A-Len, F-Addr, F-Byt, F-Len, Region, Cnv

The following fields are available on the INUSE screen:


Type, Spn, Key, U-Addr, U-Byt, U-Len, Region, Cnv

The following fields are available on the UNALLOC screen:


Addr, Len, Bytes, Region

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Addr | The address of the unallocated block of storage. |
+---------------+------------------------------------------------------------+
| A-Addr | The address of the allocated block of storage. |
+---------------+------------------------------------------------------------+
| A-Byt | The length of the allocated block of storage in decimal |
| | bytes. |
+---------------+------------------------------------------------------------+
| A-Len | The length of the allocated block of storage. |
+---------------+------------------------------------------------------------+
| Bytes | The length of the unallocated block of storage in decimal |
| | bytes. |
+---------------+------------------------------------------------------------+
| Cnv | CNV if the storage is allocated within the CSA or ECSA |
| | region but is allocated in an SQA subpool. Otherwise |
| | blank. |
+---------------+------------------------------------------------------------+
| F-Addr | The address of the free area within the allocated block. |
+---------------+------------------------------------------------------------+
| F-Byt | The length of the free area within the allocated block in |
| | decimal bytes. |
+---------------+------------------------------------------------------------+
| F-Len | The length of the free area within the allocated block. |
+---------------+------------------------------------------------------------+
| Key | The keys (0-15) of storage. |
+---------------+------------------------------------------------------------+
| Len | The length of the unallocated block of storage. |
+---------------+------------------------------------------------------------+
| Region | The region of the address. |
+---------------+------------------------------------------------------------+
| Spn | The subpool number. |
+---------------+------------------------------------------------------------+
| Total | The key totals by subpool number. |
+---------------+------------------------------------------------------------+
| Type | The type of common storage. Valid values are SQA and CSA. |
+---------------+------------------------------------------------------------+
| U-Addr | The address of the in-use area of storage. |
+---------------+------------------------------------------------------------+
| U-Len | The length of the in-use area of storage. |
+---------------+------------------------------------------------------------+
| U-Byt | The length of the in-use area of storage in decimal bytes. |
+---------------+------------------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Alloc | Invokes the COMMON ALLOC command for the specified storage |
| | type, subpool number, and key. |
| | Note: only valid from the COMMON SUMMARY screen. |
+---------------+------------------------------------------------------------+
| Inuse | Invokes the COMMON INUSE command for the specified storage |
| | type, subpool number, and key. |
| | Note: only valid from the COMMON SUMMARY screen. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| OPTIONS | Set and display miscellaneous COMMON options. |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. |
+---------------+------------------------------------------------------------+

OPTIONS Subcommand

Use the OPTIONS subcommand to set and display various COMMON


command display and processing options.

OPTIONS Subcommand Format

+---------------+------------------------------------------------------------+
| OPTIONS | [cmndopts] |
+---------------+------------------------------------------------------------+

OPTIONS Parameter Values

The following table lists and explains the valid OPTIONS parameter
values. Any number of the values can be specified in any order.
The current settings of all options are always displayed in response
to the OPTIONS subcommand.

+---------------+------------------------------------------------------------+
| Value | Explanation |
+---------------+------------------------------------------------------------+
| Adjcnvt | Control whether the common storage area sizes that are |
| NOAdjcnvt | displayed in the information area of the screen have been |
| | adjusted by the amounts of SQA converted to CSA and the |
| | calculated percentages based on the adjusted values. The |
| | initial value is ADJCNVT. |
+---------------+------------------------------------------------------------+
| EXTRact | Requests that the current option settings be extracted |
| | into a TSO CLIST or REXX EXEC variable. The variable |
| | created or updated is named SYSV_OPTIONS_COMMON. This |
| | keyword is only valid when the product is running under a |
| | TSO CLIST or REXX EXEC. EXTRACT can be specified alone or |
| | in combination with any other OPTIONS keywords. |
+---------------+------------------------------------------------------------+
CONFIRM

CONFIRM Command

The CONFIRM command is used to confirm the action that is to happen


next. Confirmation may be requested to confirm the action of a line
command, subcommand or function command.

A positive response must be entered to confirm the requested action.


All other responses will abort the action.

Command Syntax

+---------------+-----------------------------------------------------+
| CONFIRM | [confirm-text] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| confirm-text | A description of what is being confirmed. |
+------------------+--------------------------------------------------+

Notes

Confirmation will only occur for interactive sessions. The


confirmation process will be bypassed or auto-confirmed in a
non-interactive session such as: batch or API

The following can be entered as a positive response:

YES - Confirm the action requested.

ALL - When multiple line commands are processed,


the ALL response can supply the "YES"
response to all actions.

If the requested line command action issues a


message, the line command processing will be
interrupted and the confirmation message will be
presented for the next action.

If you respond "ALL NOMSG" to the confirmation


request, all actions will be confirmed and
intermediate messages will be supressed.

xxxxxxxx - All other responses will abort the requested action.

The profile option "CONFIRMDELET" specifies whether confirmation is


desired or active for the user's session.
CONFLICT

CONFLICT Command

The CONFLICT command displays enqueued resources that have


conflicting requests. The CONFLICT command shows if any jobs
are waiting for an enqueued resource and what jobs, if any,
own the resource.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CONFLICT | [ SYSTEM | SYSPLEX ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| SYSTEM | Request enqueue information to be gathered |
| | from the local system only. |
| | |
| | Enqueue information can be gathered from either |
| | local system or sysplex. The default source is |
| | determined based on the profile setting for |
| | EnqInfoXsys. |
| | |
| | The source can be overridden using the SYSTEM or |
| | SYSPLEX keyword. |
+------------------+--------------------------------------------------+
| SYSPLEX | Request enqueue information to be gathered |
| | from the sysplex. |
| | |
| | Enqueue information can be gathered from either |
| | local system or sysplex. The default source is |
| | determined based on the profile setting for |
| | EnqInfoXsys. |
| | |
| | The source can be overridden using the SYSTEM or |
| | SYSPLEX keyword. |
+------------------+--------------------------------------------------+
| XSYStem | Display information for all systems. |
| XSData | This forces cross system data collection to be |
| | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| GRS | The GRS configuration option. |
| Configuration | |
| | Possible values are: |
| | NONE |
| | RING |
| | STAR |
+------------------+--------------------------------------------------+
| EnqInfoXsys | Indicates whether the enqueue information was |
| | gathered from the sysplex. |
| | |
| | Possible values are: |
| | YES - gathered from the SYSPLEX |
| | NO - gathered from the local system |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Jobname associated with the enqueue |
+------------------+--------------------------------------------------+
| Type | Type of control over the resource. |
| | |
| | Possible values are: |
| | SHRD - Shared control over the resource |
| | EXCL - Exclusive control over the |
| | resource |
| | |
+------------------+--------------------------------------------------+
| Status | Job control status of resource |
| | |
| | Possible values are: |
| | OWNS - Display only enqueues for which |
| | the resource is available |
| | WAIT - Display only enqueues for which |
| | the resource is not available |
| | This value will be highlighted. |
| | |
+------------------+--------------------------------------------------+
| Elapsed | The elapsed time since the enqueue was issued. |
| | |
| | The elapsed value will be highlighted if |
| | Status = "WAIT" |
+------------------+--------------------------------------------------+
| Scope | Scope of the resource |
| | |
| | Possible values are: |
| | STEP - Used only within the region of |
| | the job |
| | SYSTEM - Used by more than one job on the |
| | system that issued the enqueue |
| | SYSTEMS - Shared by other systems |
| | |
+------------------+--------------------------------------------------+
| QName | QName of the resource |
+------------------+--------------------------------------------------+
| RName | RName of the resource |
+------------------+--------------------------------------------------+
| Rnl | RName length |
+------------------+--------------------------------------------------+
| SysName | System name where enqueue was issued |
+------------------+--------------------------------------------------+
| ASID | ASID of the jobname associated enqueue |
+------------------+--------------------------------------------------+
| TCB | TCB associated with the enqueue |
+------------------+--------------------------------------------------+
| EnqDate | The date when the enqueue was issued. |
+------------------+--------------------------------------------------+
| EnqTime | The time when the enqueue was issued. |
+------------------+--------------------------------------------------+
| CkSumToken | Checksum token used to represent a unique value |
| | for QNames and RNames that display hex values. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the ROWDISP command for the selected |
| | entry. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
CONSOLE

CONSOLE Command

The CONSOLE command displays messages appearing on any active


console. You can use the facilities a console provides without
having to go to the computer room.

The CONSOLE command lets you view messages currently displayed


on any active MVS console.

Command Syntax

+---------------+------------------------------------------------------------+
| CONSOLE | [id] |
| | [MASTER] |
| | [name] |
+---------------+------------------------------------------------------------+

Parameters

+---------------+------------------------------------------------------------+
| Value | Explanation |
+---------------+------------------------------------------------------------+
| id | Displays messages of the specified console. The default |
| | ID is the master console ID. To change the default, |
| | change the Default Parameters field in the Miscellaneous |
| | Section of the profile. For more information on the |
| | profile, see the help for the PROFILE command. |
+---------------+------------------------------------------------------------+
| MASTER | Displays the messages of the master console. |
+---------------+------------------------------------------------------------+
| name | Displays the messages of the named console. |
+---------------+------------------------------------------------------------+

Information Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Name | The console name. |
+---------------+------------------------------------------------------------+
| Devn | The device number of the selected console or SMCS for |
| | an SMCS console. |
+---------------+------------------------------------------------------------+
| Mode | The message deletion mode. Valid values are: |
| | |
| | Y Automatic delete mode |
| | R Roll mode |
| | RD Roll delete mode |
| | N Manual delete required |
| | W Wrap mode |
| | HL Held mode |
| | |
+---------------+------------------------------------------------------------+
| Backlog | The number of messages queued to the console that have |
| | not yet been sent. |
+---------------+------------------------------------------------------------+
| Sys | The name of system where this console is active. |
+---------------+------------------------------------------------------------+
| Cmdsys | The name of the system to which commands are sent for |
| | processing unless explicitly routed with the ROUTE |
| | command. |
+---------------+------------------------------------------------------------+

Data Fields

+--------------+------------------------------------------------------------+
| Field | Description |
+--------------+------------------------------------------------------------+
| Message | Console message area. |
+--------------+------------------------------------------------------------+

Notes

* When a particular console is chosen, the ID of the console


is saved. The saved ID is used with the CONSOLE command the
next time it is executed.

* You can enter operator commands using the MVS command. For
details on entering operator commands from the CONSOLE display,
see the help for the MVS command.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Delete | Delete the message from the MVS console screen. The |
| | message is marked as a candidate for deletion. When |
| | space is required on the screen, the message is physically |
| | deleted. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| OPTIONS | Controls console display options. |
+---------------+------------------------------------------------------------+
| RELEASE | Releases the console from HOLD mode. |
+---------------+------------------------------------------------------------+
| LASTCMDS | Displays the last 1-15 commands entered from the console. |
+---------------+------------------------------------------------------------+

OPTIONS Subcommand

Use the OPTIONS subcommand to control the console display


options.

OPTIONS Subcommand Format

+---------------+------------------------------------------------------------+
| OPTIONS | [keyword][,value] |
+---------------+------------------------------------------------------------+

OPTIONS Parameter Values

+------------+------------+--------------------------------------------------+
| Keyword | Value | |
| Value | Value | Explanation |
+------------+------------+--------------------------------------------------+
| MERGE | YES | Split lines should be merged. |
| | | |
| | NO | Split lines should not be merged. |
| | | |
| | COND | Split lines should be merged only if the |
| | | terminal line width is greater than 80 columns. |
| | | This is the default. |
+------------+------------+--------------------------------------------------+
| POSITION | TOP | Simulated screen should be positioned at the top |
| | | of the actual console screen data. |
| | | |
| | BOTTOM | Simulated screen should be positioned at the |
| | | bottom of the actual console screen data. This |
| | | is the default. |
| | | |
| | COND | Simulated screen should be positioned as in |
| | | BOTTOM unless the first row of the actual |
| | | console screen is a non-roll deleteable message. |
| | | Otherwise, the simulated screen is positioned as |
| | | in TOP. |
+------------+------------+--------------------------------------------------+

OPTIONS Subcommand Notes

* Keyword/value pairs may be specified in any order.

* If a keyword is repeated, then the last value specified


is used.

* If no keyword/value pairs are specified, then the current


parameter settings are displayed.

* Changes made with the OPTIONS subcommand are saved in


the profile.

RELEASE Subcommand

Use the RELEASE subcommand to release the actual console from


HOLD mode. Hold is indicated by Mode=HL in the information
fields display.

RELEASE Subcommand Format

+---------------+------------------------------------------------------------+
| RELEASE | |
+---------------+------------------------------------------------------------+
LASTCMDS Subcommand

Use the LASTCMDS subcommand to display a list of the last 1-15


commands entered from the actual console. The number of commands
displayed depends on the RBUF keyword value on the CONSOLE
statement in the CONSOLxx member of SYS1.PARMLIB. RBUF keyword
support requires APARs OY39865 and OY41610.

LASTCMDS Subcommand Format

+---------------+------------------------------------------------------------+
| LASTCMDS | |
+---------------+------------------------------------------------------------+

Messages

CONS001E No usable console available

The search for a suitable default console has failed because


no usable console can be found. To be usable, a console must be
active on the current system, be in full-capability mode, and be
a 3270-type device.

CONS002E Invalid console - [conid]

The console [conid] is not valid; it must be one or two decimal


digits, the keyword MASTER, or a valid console name. Issue the
command again with a valid console identifier.

CONS003E Console [conid] not found

The console [conid] cannot be found. Use the LISTCONS command


to display the status of all defined consoles.

CONS004E Console [conid] is not active

The console [conid] is not active. To be usable, a console must


be active, in full-capability mode, and be a 3270-type device.

CONS005E Console [conid] is not full-capability

The console [conid] is not in full-capability mode. To be usable,


a console must be active, in full-capability mode, and be a
3270-type device.

CONS006E Console [conid] unit type [unittype] unsupported

The unit type [unitype] of the console [conid] is not supported.


To be usable, a console must be active, in full-capability mode,
and be a 3270-type device.

CONS007E Console [name] is not active on this system

The requested console is active on another system in the sysplex.


Only consoles active on the system you are on can be displayed.

CONS008E Console [name] invalid data returned

The data requested from the console was invalid. You may need to
refresh the display. If the error persists contact technical
support.
CONS009E Console [consid] is in the process of being closed

Console [consid] is currently being closed and is not available


for selection. Use the LISTCONS command to determine the console
available for selection.
CONTROL

CONTROL Command

The CONTROL command is used to control CLIST processing options.


CONTROL is only valid when entered through a command list which
was generated by either the CLIST or RXCLIST command.

Command Syntax

+---------------+------------------------------------------------------------+
| CONTROL | [ FLUSH ] [ XLATE ] |
| | [ NOFLUSH ] [ NOXLATE ] |
+---------------+------------------------------------------------------------+

Parameters

+---------------+------------------------------------------------------------+
| Parameter | Explanation |
+---------------+------------------------------------------------------------+
| FLUSH | Specifies that if an error occurs while executing a |
| | command in a CLIST, then the remaining commands are not |
| | executed. An error is indicated by an error message. |
| | FLUSH is the default for CLIST processing. |
+---------------+------------------------------------------------------------+
| NOFLUSH | Specifies that if an error occurs while executing a |
| | command in a CLIST, then the remaining commands are not |
| | affected. The use of this option can cause unpredictable |
| | results if any command relies on the successful execution |
| | of a previous command that has failed. |
+---------------+------------------------------------------------------------+
| XLATE | Specifies that default mask characters in a CLIST are |
| | to be translated to the user specified mask characters. |
| | The default fixed length mask character is *. |
| | The default variable length mask character is =. |
| | |
| | If a CLISTLIB member contains commands that specify |
| | parameters using the variable length or fixed length |
| | mask characters, then the characters may need to be |
| | translated to the specified characters of the user. This |
| | would typically be true if the member resides in the |
| | system CLISTLIB that is used for all users. |
| | |
| | As a rule, if the CLISTLIB member is to contain mask |
| | characters, then the default mask characters should be |
| | used with the CONTROL statement specifying XLATE. |
| | |
| | NOXLATE is the default. |
+---------------+------------------------------------------------------------+
| NOXLATE | Specifies that default mask characters are not to be |
| | translated to the user specified mask characters. |
+---------------+------------------------------------------------------------+

Messages

CNTL001W CONTROL only valid in a CLIST


The CONTROL command only has meaning when it is issued in a CLIST
and is otherwise ignored.
CPCGROUP

CPCGROUP Command

The CPCGROUP command displays the group capacity information for


local LPAR's capacity group.

Command Syntax

+------------------+--------------------------------------------------+
| CPCGROUP | [ GROUP groupname ] |
| | [ CAPacity capacity ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| GROUP | This optional parameter specifies the name of a |
| | capacity group that is to be simulated. If the |
| | current LPAR is not participating in a Capacity |
| | Group or you want to simulate a Capacity Group |
| | with LPARs of your choosing, use this parameter |
| | to select a group. |
| | |
| | To simulate a capacity group: |
| | |
| | o Define a group of type SYSNAME to contain a |
| | list of LPARs that are to be combined into a |
| | simulated capacity group. |
| | |
| | o Specify the group name using this GROUP |
| | parameter. |
| | |
| | The list of available groups with type |
| | SYSNAME can be found on the GROUPS command. |
| | |
| | See Note 3 below for details on simulating |
| | a capacity group in the MVS data collector. |
+------------------+--------------------------------------------------+
| CAPACITY | This optional parameter specifies a group |
| | capacity value when simulating a capacity group. |
| | It has no affect unless the GROUP parameter |
| | is also specified. |
| | |
| | If capacity is not specified during simulation, |
| | the LPAR image capacity of all LPARs in the |
| | simulation group are added together to form |
| | the group capacity. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| CPC | Central Processor Complex name. |
+------------------+--------------------------------------------------+
| CPCCap | The CPC CPU capacity in millions of service |
| | units (MSU) per hour. |
+------------------+--------------------------------------------------+
| Group | The name of the local LPARs capacity group. |
| | |
| | If the LPAR does not belong to a capacity group |
| | the group name will be listed as NOGROUP. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| LPARName | The name of an LPAR in the group |
+------------------+--------------------------------------------------+
| Status | The status of the GROUP or LPAR row |
| | |
| | For a GROUP row (the Type field indicates GROUP) |
| | valid values are: |
| | VALID The group capacity could be properly |
| | calculated based on availability |
| | of all LPARs in the group. See |
| | LPAR row status values below. |
| | INVALID The group capacity could not be |
| | calculated because one or more |
| | LPARs in the group could not be |
| | reached using CCI. |
| | See LPAR row status values below. |
| | |
| | For an LPAR row (the Type field indicates LPAR) |
| | valid values are: |
| | ACTIVE The LPAR is active and statistics |
| | could be obtained. |
| | INACTIVE The LPAR is not currently active. |
| | (See Note 1 below) |
| | NOCOM The LPAR is active but could not |
| | be reached using CCI. |
| | (See Note 2 below) |
| | NODEF The LPAR is in the capacity group |
| | definition, but it is not actually |
| | defined to the CPC. |
| | (See Note 1 below) |
| | NOSTATS The LPAR is active and could be |
| | reached using CCI, but no statistics |
| | were returned. This may be due to |
| | an older verion of SYSVIEW is |
| | running or two data collection |
| | cycles has not yet occurred. |
| | (See Note 2 below) |
| | |
+------------------+--------------------------------------------------+
| Capacity | The capacity in millions of service units (MSU) |
| | per hour. For a group line (Type field is GROUP) |
| | this represents the capacity group's MSU value. |
| | For an LPAR line (Type field is LPAR) this |
| | represents the LPAR's MSU value. |
+------------------+--------------------------------------------------+
| Unused | The average MSU/hour unused capacity during the |
| | last 4 hours. |
| | |
| | The value will be displayed as a negative |
| | highlighted value if the average is above the |
| | defined capacity. |
+------------------+--------------------------------------------------+
| 4hAvg | The average MSU/hour consumed during the last |
| | 4 hours. |
| | |
| | For a GROUP row (the Type field indicates GROUP) |
| | this value represents the total of the four hour |
| | average value of all LPARs in the capacity |
| | group. |
| | |
| | For an LPAR row (the Type field indicates LPAR) |
| | this value represents the LPARs 4 hour average. |
+------------------+--------------------------------------------------+
| 4hPct | The percentage of the capacity used during the |
| Pctgraph | last 4 hours "4hAvg". |
| | |
| | pct = 4hAvg * 100 |
| | ----------- |
| | Capacity |
| | |
| | For a GROUP row (the Type field indicates GROUP) |
| | this value represents the percentage of the |
| | capacity group used. |
| | |
| | For an LPAR row (the Type field indicates LPAR) |
| | this value represents the percentage of the |
| | LPAR's capacity used. |
| | |
+------------------+--------------------------------------------------+
| Sysplex | The name of the SYSPLEX where the LPAR is a |
| | member. |
+------------------+--------------------------------------------------+
| Type | The type of row. Valid values are: |
| | GROUP The row represents a capacity group |
| | LPAR The row represents an LPAR |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Select | Invokes the CPCLPAR command for the selected LPAR. |
+---------------+------------------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

1. The CPC MSU statistics are still able to be calculated since the
LPAR is not active.
2. The CPC MSU statistics cannot be properly calculated because the
LPAR is active, but its statistics could not be obtained.
3. To simulate a capacity group such that the MVS data collector
would calculate the group capacity metrics based on a simulation
group, you can configure the the MSU-4Hour-Group-Simulate-xxxx
parameters in the MVSDATA PARMLIB member.

If you specify a simulation group name in the MVSDATA PARMLIB


member, you do not have to specify it on this command.
The command will discover the simluated group name
automatically.
CPCLPAR

CPCLPAR Command

The CPCLPAR command provides a summary of CPC capacity for the LPAR.
The data allows you to compare defined capacity limits against
actual MSU consumption for the current LPAR.

Command Syntax

+------------------+--------------------------------------------------+
| CPCLPAR | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Partition | The logical partition name. |
+------------------+--------------------------------------------------+
| CPC Capacity | The CEC CPU capacity in millions of service |
| | units (MSU) per hour. |
+------------------+--------------------------------------------------+
| Image Capacity | The logical partition CPU capacity in millions |
| | of services units (MSU) per hour. |
+------------------+--------------------------------------------------+
| Avg Weight | The average weight of the image since IPL. |
+------------------+--------------------------------------------------+
| WLM Capping% | The percentage of time that WLM capped the |
| | partition because the 4 hour average MSU value |
| | exceeds the defined capacity limit. If no |
| | defined capacity limit has been set "n/a" will |
| | be shown; this value is not applicable to group |
| | capacity limits. |
+------------------+--------------------------------------------------+
| Group | The name of the capacity group if the partition |
| | belongs to a capacity group and is managed |
| | towards the common group capacity limit. |
+------------------+--------------------------------------------------+
| Limit | The capacity limit in MSU/hour defined for the |
| | partition's capacity group. |
+------------------+--------------------------------------------------+
| 4h Avg | The average MSU/hour consumed during the last |
| | 4 hours. |
| | |
| | The percentage of the logical partition CPU |
| | capacity "Image" used. |
| | |
| | If this value is above the partition's |
| | defined capacity the partition will be capped. |
| | |
| | The status of this field is based on a |
| | threshold definition for: |
| | |
| | MVS_SYS_4HourLparAvgMsu |
| | MVS_SYS_4HourLparAvgMsu% |
| | |
+------------------+--------------------------------------------------+
| 4h Max | The maximum MSU/hour consumed during the last |
| | 4 hours. The value is based on an interval |
| | of 5 minutes. |
| | The percentage of the logical partition CPU |
| | capacity "Image" used. |
+------------------+--------------------------------------------------+
| 4h Unused | The average MSU/hour unused capacity during the |
| | last 4 hours. |
| | |
| | The percentage of the logical partition CPU |
| | capacity "Image" unused. |
| | |
| | The value will be displayed as a negative |
| | highlighted value if the average is above the |
| | defined capacity. |
| | |
| | unused = Image Capacity - 4h Avg |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: Intv,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Intv | The collection interval. |
+------------------+--------------------------------------------------+
| Time | The approximate end time of the collection |
| | interval. |
+------------------+--------------------------------------------------+
| SrvUnits | The total service units accumulated. |
| | SrvUnits = "UnCapped" + "Capped" |
+------------------+--------------------------------------------------+
| SrvUTime | The total elapsed time accumulated. |
| | SrvUTime = "UCapTime" + "CapTime" |
+------------------+--------------------------------------------------+
| Unused | The unused MSU for 1 hour. |
| | |
| | The value will be displayed as a negative |
| | highlighted value if the average is above the |
| | defined capacity. |
+------------------+--------------------------------------------------+
| 1hMSU | The MSU that would be consumed for 1 hour. |
| | |
| | The status of this field is based on a |
| | threshold definition for: MVS_SYS_1HourLparMsu |
+------------------+--------------------------------------------------+
| Pct% | The percentage of the logical partition CPU |
| Pctgraph | capacity "Image" used for the interval. |
| | |
| | pct = 1hMSU * 100 |
| | ----------- |
| | Image |
| | |
| | The status of this field is based on a |
| | threshold definition for: MVS_SYS_1HourLparMsu% |
+------------------+--------------------------------------------------+
| Capped | The service units accumulated while the |
| | partition was capped. This is only valid |
| | if a defined capacity limit was specified. |
+------------------+--------------------------------------------------+
| CapTime | The elapsed time that the partition was |
| | capped. This is only valid if a defined |
| | capacity limit was specified. |
+------------------+--------------------------------------------------+
| UnCapped | The service units accumulated while the |
| | partition was uncapped. |
+------------------+--------------------------------------------------+
| UCapTime | The elapsed time that the partition was |
| | uncapped. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Related Information

CPC LPAR capacity summary


Partition information
PR/SM and LPAR information
CPCSUM

CPCSUM Command

The CPCSUM command provides a summary of CPC capacity within your


data center. The summary allows you to compare defined capacity
limits against actual MSU consumption for multiple partitions.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| CPCSUM | [ XSYstem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYstem | Specifies that data from all connect systems |
| XSData | is to be displayed. |
| | This forces cross system data collection to be |
| | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYstem | Specifies that only data from the current system |
| NOXSData | is to be displayed. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: LPARName,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| LPARName | The logical partition name. |
+------------------+--------------------------------------------------+
| CPC | The CEC CPU capacity in millions of service |
| | units (MSU) per hour. |
+------------------+--------------------------------------------------+
| Image | The logical partition CPU capacity in millions |
| | of services units (MSU) per hour. |
+------------------+--------------------------------------------------+
| Unused | The average MSU/hour unused capacity during the |
| | last 4 hours. |
| | |
| | The value will be displayed as a negative |
| | highlighted value if the average is above the |
| | defined capacity. |
+------------------+--------------------------------------------------+
| 4hAvg | The average MSU/hour consumed during the last |
| | 4 hours. |
+------------------+--------------------------------------------------+
| 4hMax | The maximum MSU/hour consumed during the last |
| | four hours. The value is based on an interval |
| | of 5 minutes. |
+------------------+--------------------------------------------------+
| Pct% | The percentage of the logical partition CPU |
| Pctgraph | capacity "Image" used during the last 4 hours |
| | "4hAvg". |
| | |
| | pct = 4hAvg * 100 |
| | ----------- |
| | Image |
+------------------+--------------------------------------------------+
| Group | The name of the capacity group if the partition |
| | belongs to a capacity group and is managed |
| | towards the common group capacity limit. |
+------------------+--------------------------------------------------+
| Limit | The capacity limit in MSU/hour defined for the |
| | partition's capacity group. |
+------------------+--------------------------------------------------+
| Capped | The service units accumulated while the |
| | partition was capped. This is only valid |
| | if a defined capacity limit was specified. |
+------------------+--------------------------------------------------+
| CapTime | The elapsed time that the partition was |
| | capped. This is only valid if a defined |
| | capacity limit was specified. |
+------------------+--------------------------------------------------+
| UnCapped | The service units accumulated while the |
| | partition was uncapped. |
+------------------+--------------------------------------------------+
| UCapTime | The elapsed time that the partition was |
| | uncapped. |
+------------------+--------------------------------------------------+
| Total | The total service units accumulated. |
| | Total = "UnCapped" + "Capped" |
+------------------+--------------------------------------------------+
| TotTime | The total elapsed time accumulated. |
| | TotTime = "UCapTime" + "CapTime" |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands


Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the CPCLPAR command for the selected |
| | LPARName. |
+------------------+--------------------------------------------------+
| Plot | Plot the four hour average MSU percentage for |
| | the selected LPAR. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Related Information

Partition information
PR/SM and LPAR information
CPFTABLE

CPFTABLE Command

The CPFTABLE command displays the contents of the Command Prefix Table.

Command Syntax

+---------------+------------------------------------------------------------+
| CPFTABLE | |
+---------------+------------------------------------------------------------+

Parameters

This command has no parameters.

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Prefix | The command prefix. |
+---------------+------------------------------------------------------------+
| Owner | The name of the application owning the command prefix. |
+---------------+------------------------------------------------------------+
| System | The name of a system in the sysplex to which the command |
| | is routed for execution. |
+---------------+------------------------------------------------------------+
| Scope | The range of systems to which a command with this prefix |
| | can be routed for execution. Valid values are: |
| | |
| | SYSPLEX The command issued can be routed to another |
| | system in the sysplex for execution |
| | SYSTEM The command issued executes in the system on |
| | which it was entered |
+---------------+------------------------------------------------------------+
| Remove | Specifies whether the command prefix is removed from the |
| | command text prior to execution on the receiving system. |
+---------------+------------------------------------------------------------+
| Faildisp | Specifies the failure disposition of the prefix. Valid |
| | values are: |
| | |
| | PURGE The command prefix is deleted when the |
| | receiving system is removed from the |
| | sysplex, or the defining address space |
| | terminates |
| | SYSPURGE The command prefix is deleted when the |
| | receiving system is removed from the |
| | sysplex, but not when the defining address |
| | space terminates |
| | RETAIN The command prefix remains even if a system |
| | is removed or an address space terminates |
+---------------+------------------------------------------------------------+

Line Commands
No line commands are defined by the &HelpMember command, however
other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. |
+---------------+------------------------------------------------------------+
CPIPE

CPIPE Command

The CPIPE command displays the current status of CICS pipelines.


A pipeline is used when a CICS application is acting as a
Web service provider or requester.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CPIPE | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Pipeline,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Pipeline | Specifies the name of the pipeline. |
+------------------+--------------------------------------------------+
| Type | Specifies the pipeline type. |
| | Possible values are: |
| | PROVIDER - CICS is using the pipeline as a |
| | service provider. |
| | PROVJSON - CICS is using the pipeline as a |
| | JSON service provider. |
| | REQUEST - CICS is using the pipeline as a |
| | service requester. |
| | UNKNOWN - The operating mode type cannot be |
| | blank determined. |
+------------------+--------------------------------------------------+
| Status | Specifies the status of the pipeline. |
| | Possible values are: |
| | DISABING |
| | DISABLED |
| | DISCARD |
| | ENABLED |
| | ENABLING |
| | INITING |
| | LOCKFAIL |
| | OSFAIL |
| | STGFAIL |
+------------------+--------------------------------------------------+
| Desired | Specifies the desired status. |
+------------------+--------------------------------------------------+
| Count | Current usage count |
+------------------+--------------------------------------------------+
| Total | Total usage count |
+------------------+--------------------------------------------------+
| AppHandl | Specifies the message application handler name. |
+------------------+--------------------------------------------------+
| LockHeld | Indicate if a lock is currently held. |
+------------------+--------------------------------------------------+
| LockTokn | Specifies the lock token value. |
+------------------+--------------------------------------------------+
| DFHPIPEB | Specifies the address of the DFHPIPEB |
| | control block. |
+------------------+--------------------------------------------------+
| ConfigFile | Specifies an HFS file name that contains |
| | information about the processing nodes that will |
| | process the service requests. |
+------------------+--------------------------------------------------+
| Shelf | Specifies the HFS shelf file name. |
+------------------+--------------------------------------------------+
| WSDir | Specifies the WSBind file directory. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CPROCTYP

CPROCTYP Command

The CPROCTYP command displays information about business transaction


services (BTS) PROCESSTYPE definitions.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CPROCTYP | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Process,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Process | The name of the defined process type. |
+------------------+--------------------------------------------------+
| Status | The enabled status. |
| | Possible values are: |
| | ENABLED |
| | DISABLED |
+------------------+--------------------------------------------------+
| File | The CICS repository file were process and |
| | activity records for processes are stored. |
+------------------+--------------------------------------------------+
| AuditLog | The name of the CICS journal used as the |
| | audit log for this process type. |
+------------------+--------------------------------------------------+
| AuditLvl | The level of audit logging currently active. |
| | Possible values are: |
| | ACTIVITY |
| | FULL |
| | OFF |
| | PROCESS |
+------------------+--------------------------------------------------+
| DefGroup | The name of the definition group from where |
| | the entry was installed. |
+------------------+--------------------------------------------------+
| PTT | The address of the PTT control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CPROFILE

CPROFILE Command

The CPROFILE command displays information about CICS terminal


profile definitions.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CPROFILE | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Profile,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Profile | The name of the profile definition. |
+------------------+--------------------------------------------------+
| Scrnsize | Specifies whether the DEFAULT or ALTERNATE |
| | buffer size will be used. |
+------------------+--------------------------------------------------+
| Uctran | Specifies whether terminal input will be |
| | translated to uppercase before passed to |
| | programs. |
+------------------+--------------------------------------------------+
| Modename | The name of a group of sessions for use on an |
| | APPC connection. |
+------------------+--------------------------------------------------+
| Fac | Specifies the name of an existing terminal |
| | resource definition to be used as a |
| | template for the bridge facility. |
+------------------+--------------------------------------------------+
| Printer | Specifies the level of compatibility of |
| | data streams to support the printer option |
| | for the BMS SEND TEXT command. |
| | |
| | Possible values are: |
| | |
| | PRINTER - No blank character is inserted. |
| | The first character of data is |
| | honored and the full width of |
| | the printer is available. |
| | |
| | blank - Each output line starts with |
| | a blank character. |
| | |
+------------------+--------------------------------------------------+
| Jrnl | Specifies the journal ID for automatic |
| | journaling of messages. |
| | |
| | blank - No automatics journal of messages |
| | |
+------------------+--------------------------------------------------+
| MsgJrnl | Specifies which messages are to be automatically |
| | journaled. |
| | |
| | Possible values are: |
| | |
| | NONE - No message journaling |
| | |
| | INPUT - Input messages are journaled |
| | |
| | OUTPUT - Output messages are journaled |
| | |
| | INOUT - Input and output messages are |
| | journaled |
| | |
+------------------+--------------------------------------------------+
| MsgInteg | Specifies whether a definite response is to be |
| | requested with an output request |
+------------------+--------------------------------------------------+
| OneWrite | Specifies whether the transaction is permitted |
| | only one write or EXEC CICS SEND |
+------------------+--------------------------------------------------+
| Chain | Specifies whether the program can control the |
| | outbound chaining of request units. |
+------------------+--------------------------------------------------+
| NonVTAM | The profile can be used with non-VTAM terminals |
+------------------+--------------------------------------------------+
| VTAM | The profile can be used with VTAM logical units |
+------------------+--------------------------------------------------+
| FMH | For profiles that use logical units, this |
| | option specifies whether a Function Management |
| | Header received from a logical unit is to |
| | be passed to the application program. |
| | |
| | Possible values are: |
| | |
| | blank - The FMHs are discarded |
| | |
| | ALL - All FMHs are passed to the |
| | application program |
| | |
| | EODS - An FMH is passed to the application |
| | program only if it indicates |
| | end of data |
| | |
| | DIP - The batch data interchange program |
| | is to process inbound FMHs |
| | |
+------------------+--------------------------------------------------+
| RAQ | Specifies whether the "read ahead queuing" |
| | option is required |
+------------------+--------------------------------------------------+
| LogRec | Specifies whether the application program |
| | requires that each EXEC CICS RECEIVE request |
| | is to be satisfied by a logical record |
+------------------+--------------------------------------------------+
| NepClass | Specifies the node error program transaction |
| | class. |
| | |
| | Possible values are: |
| | |
| | 0 - Results in a link to the default |
| | node error program module for |
| | VTAM devices or is the default |
| | value for non-VTAM devices |
| | |
| | value - The transaction class for the |
| | node error program module |
| | |
+------------------+--------------------------------------------------+
| RTimeOut | Specifies the read time-out value. |
+------------------+--------------------------------------------------+
| DFHPPFPS | The address of the DFHPPFPS control block. |
+------------------+--------------------------------------------------+
| DefGroup | The name of the definition group from where |
| | the entry was installed. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the CTRANS command selecting the |
| | transactions with a matching profile |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch


This command performs an automatic address space switch to the
jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CPROGRAM

CPROGRAM Command

The CPROGRAM command displays a list of CICS program definitions and


statistics. Multiple programs of the same name can be in storage
if a newcopy function has been performed.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CPROGRAM | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+
| Usage | The program storage usage for each DSA. |
| | Info area cursor selection support. |
+------------------+--------------------------------------------------+
| Redundant | The amount of storage that is not being used. |
| | Info area cursor selection support. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Program,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname that owns the resource. |
+------------------+--------------------------------------------------+
| Program | The name of the program. |
+------------------+--------------------------------------------------+
| InUse | The number of separate users currently using the |
| | program. |
+------------------+--------------------------------------------------+
| Count | The number of times the program was used since |
| | CICS startup. |
+------------------+--------------------------------------------------+
| Fetch | The number of times the program was fetched |
| | since CICS startup. |
+------------------+--------------------------------------------------+
| Size | The size of the program in bytes. |
+------------------+--------------------------------------------------+
| Length | The length of the program in hexadecimal bytes. |
+------------------+--------------------------------------------------+
| RPL | The offset number in the DFHRPL concatenation |
| | from where the program was loaded. |
| | |
| | If the program was loaded from LPA, the value |
| | LPA is displayed. If the program was loaded from |
| | the region, the value RGN is displayed. |
+------------------+--------------------------------------------------+
| Library | The name of the program library or DD name from |
| | where the program was loaded. |
| | |
| | If the program was loaded from LPA, the value |
| | LPA is displayed. If the program was loaded from |
| | the region, the value STEPLIB is displayed. |
+------------------+--------------------------------------------------+
| Copy | The copy number of the program. |
+------------------+--------------------------------------------------+
| Remove | The number of times the program was removed from |
| | storage since the last CICS statistics reset. |
+------------------+--------------------------------------------------+
| LCount | The number of times the program was used since |
| | the last CICS statistics reset. |
+------------------+--------------------------------------------------+
| LFetch | The number of times the program was fetched |
| | since the last CICS statistics reset. |
+------------------+--------------------------------------------------+
| FtchTime | The total amount of time spent fetching the |
| | program since the last CICS statistics reset. |
+------------------+--------------------------------------------------+
| Load | The program load address. |
+------------------+--------------------------------------------------+
| Entry | The program entry address. |
+------------------+--------------------------------------------------+
| DSAname | The Dynamic Storage Area in which the program is |
| | loaded. |
+------------------+--------------------------------------------------+
| Lng | The programming language for the program. |
| | |
| | The language is as defined for the program, or |
| | as deduced by CICS when the program was loaded |
| | if available. |
| | |
| | Possible values are: |
| | |
| | NODEF Not defined |
| | ASM Assembler |
| | C C |
| | COBOL COBOL |
| | JVM JVM |
| | LE370 LE/370 |
| | PLI PL/I |
+------------------+--------------------------------------------------+
| CEDF | Specifies that CEDF is available. |
+------------------+--------------------------------------------------+
| EXECKey | The CICS execution key. |
| | |
| | Possible values are: |
| | |
| | USER |
| | CICS |
+------------------+--------------------------------------------------+
| DataLoc | The default data location for GETMAINS. |
| | |
| | Possible values are: |
| | |
| | ANY |
| | BELOW |
+------------------+--------------------------------------------------+
| Disabled | Specifies that the program is disabled. The |
| | program is not available for use. |
+------------------+--------------------------------------------------+
| CopyStatus | The load status of the program. |
| | |
| | Possible values are: |
| | |
| | REQUIRED |
| | NOTREQUIRED |
+------------------+--------------------------------------------------+
| CPE | The address of the CPE control block. |
+------------------+--------------------------------------------------+
| SysID | The name of the remote system. |
+------------------+--------------------------------------------------+
| RProgram | The name of the remote program. |
+------------------+--------------------------------------------------+
| RTran | The name of the server transaction. |
+------------------+--------------------------------------------------+
| Con | The defined program concurrency. |
| | |
| | Possible values are: |
| | |
| | QR Quasi Re-entrant |
| | TS ThreadSafe |
| | REQ OTE Required |
+------------------+--------------------------------------------------+
| ExecSet | Specifies if CICS is to link to and run the |
| | program as if it were running in a remote |
| | CICS region. |
| | |
| | Possible values are: |
| | |
| | FULLAPI - CICS is to link to the program and |
| | run it without the API restrictions |
| | of a DPL program. The program can |
| | use the full CICS API. |
| | DPL - CICS is to link to the program and |
| | run it with the API restrictions |
| | of a remote DPL program. |
+------------------+--------------------------------------------------+
| API | Specifies the API to be used by the program. |
| | |
| | Possible values are: |
| | |
| | CICSAPI - CICS application programming |
| | interfaces only |
| | OPENAPI - The program is not restricted to |
| | the CICS application program |
| | interfaces |
+------------------+--------------------------------------------------+
| JVM | Indicates the program is to be run under JVM. |
+------------------+--------------------------------------------------+
| JVMServer | The JVM server resource name. |
+------------------+--------------------------------------------------+
| JVMProf | The JVM profile member name. |
+------------------+--------------------------------------------------+
| DatasetName | The data set name from which a module has been |
| | loaded. The data set name will be displayed |
| | for those modules that are currently loaded |
| | from DFHRPL or a CICS dynamic library. |
+------------------+--------------------------------------------------+
| DefGroup | The name of the definition group from where |
| | the entry was installed. |
+------------------+--------------------------------------------------+
| Bundle | The library name for the bundle. |
+------------------+--------------------------------------------------+
| Application | The application name. |
+------------------+--------------------------------------------------+
| Operation | The operation name. |
+------------------+--------------------------------------------------+
| Platform | The platform name. |
+------------------+--------------------------------------------------+
| Major | The major version. |
+------------------+--------------------------------------------------+
| Minor | The minor version. |
+------------------+--------------------------------------------------+
| Micro | The micro version. |
+------------------+--------------------------------------------------+
| PPTE | The address of the PPTE control block. |
+------------------+--------------------------------------------------+
| PPTE64 | The address of the PPTE64 control block. |
+------------------+--------------------------------------------------+
| APE | The address of the APE control block. |
+------------------+--------------------------------------------------+
| PLIBE | The address of the Program Library Element. |
+------------------+--------------------------------------------------+
| IAE | The address of the IAE control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DISable | Disables the program so that it is not available |
| | for use. |
+------------------+--------------------------------------------------+
| ENAble | Enables the program so that it is available for |
| | use. |
+------------------+--------------------------------------------------+
| NEWcopy | Requests a new copy of the program to be loaded. |
| NC | |
+------------------+--------------------------------------------------+
| PHasein | Requests a new copy of the program to be phased |
| | in. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DDlist | The DDLIST command is invoked for the DD name in |
| | the Library field. |
| | |
| | If the Library field is LPA, then the LPALIST |
| | command is invoked. |
| | |
| | If the Library field is blank, then the CLIBS |
| | command is invoked. |
| | |
| | The WHERE subcommand is also issued for the |
| | program. |
+------------------+--------------------------------------------------+
| DSN | Display the data set name from where the program |
| | was loaded. |
+------------------+--------------------------------------------------+
| LIB | Invokes the CLIBS command and issues the WHERE |
| | subcommand for the program. |
+------------------+--------------------------------------------------+
| Use | Invokes the CPROGUSE command to display program |
| | usage. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CPROGRAM command security


CPROGUSE

CPROGUSE Command

The CPROGUSE command displays programs used by a transaction since the


start of the SYSVIEW for CICS data collector.

A CICS systems programmer knows that a COMMAREA can be used to pass


data between programs. What is not known, is which transactions and
programs are using COMMAREAs to pass data and the sizes of the COMMAREAs.

The CPROGUSE command provides you with a dynamic view into the usage
of COMMAREAs. The maximum inbound and outbound length of a COMMAREA
is tracked by program.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CPROGUse | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Tran,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Tran | The transaction ID. |
+------------------+--------------------------------------------------+
| Program | The program name. |
+------------------+--------------------------------------------------+
| SSID | The CICS subsystem ID where the program |
| | executed. If blank, the program executed |
| | on the local CICS region. |
+------------------+--------------------------------------------------+
| Type | The Program environment type. |
| | Possible values are: |
| | |
| | * - Non-CICS program |
| | SYSTEM - CICS system program |
| | EXEC - Command level application |
| | URM - User-replaceable program |
| | TRUE - Task-related user exit |
| | PLT - Program List Table program |
| | LOAD - Loaded module |
| | |
| | Program timing values will only be calculated |
| | for type: EXEC |
| | |
+------------------+--------------------------------------------------+
| Count | The number of times the program has been |
| | used. |
+------------------+--------------------------------------------------+
| AvgTime | The average program request time. |
+------------------+--------------------------------------------------+
| Errors | The number of requests that completed with a |
| | non-zero return code. |
+------------------+--------------------------------------------------+
| Abends | The number of abends in the program. |
+------------------+--------------------------------------------------+
| InCAL | The maximum length of any inbound COMMAREA sent |
| | to the program. |
+------------------+--------------------------------------------------+
| OutCAL | The maximum length of any outbound COMMAREA sent |
| | from the program. |
+------------------+--------------------------------------------------+
| Elapsed | The elapsed time since the program was last used.|
+------------------+--------------------------------------------------+
| LastDate | The date that the program was last used. |
+------------------+--------------------------------------------------+
| LastTime | The time that the program was last used. |
+------------------+--------------------------------------------------+
| InitDate | The date that the program was first used. |
+------------------+--------------------------------------------------+
| InitTime | The time that the program was first used. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the CTRANLOG command to display |
| | records for the selected transaction ID for |
| | the period of 1 day. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CPU

CPU Command

The CPU command displays processor information.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+----------+----------------------------------------------------------+
| CPU | [options] |
+----------+----------------------------------------------------------+

Parameters

The following table lists and explains the valid CPU command option
parameter values. Any number of values can be specified in any order.
The options specified on the CPU command are not saved from one
invocation of the CPU command to the next. Options specified with the
OPTIONS subcommand are saved in your profile. These are then the
defaults that the CPU options will override. The defaults listed in
the table below are the initial defaults. Your defaults may be
different if you have used the OPTIONS subcommand.

If you have tried various combinations of CPU command options and


have arrived at a set that you would like to save as your defaults,
enter the OPTIONS subcommand with no operands. This saves the current
set of options as your defaults.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| SUmmary | Controls whether or not the summary ALL lines |
| NOSUmmary | will be displayed. The default is SUMMARY. |
+---------------+-----------------------------------------------------+
| Detail | Controls whether or not the detail processor lines |
| NODetail | will be displayed. The default is DETAIL. |
+---------------+-----------------------------------------------------+
| Cp | Controls whether or not CP processors will be |
| NOCp | included in the display. The default is CP. |
+---------------+-----------------------------------------------------+
| SP | Controls whether or not the ALL SP line will be |
| NOSP | displayed. The ALL SP line displays the total of |
| | special purpose processors - IIPs and IFAs. |
+---------------+-----------------------------------------------------+
| IFa | Controls whether or not IFA processors will be |
| NOIFa | included in the display. The default is IFA. |
+---------------+-----------------------------------------------------+
| IIp | Controls whether or not IIP processors will be |
| NOIIp | included in the display. The default is IIP. |
+---------------+-----------------------------------------------------+
| Offline | Controls whether or not offline processors will be |
| NOOffline | included in the display. The default is OFFLINE. |
| | Processors marked as 'NOTAVL' when SMT is enabled |
| | are treated as offline for filtering purposes. |
+---------------+-----------------------------------------------------+
| Parked | Controls whether or not parked processors will be |
| NOParked | included in the display. The default is PARKED. |
+---------------+-----------------------------------------------------+
| BYAddr | Controls the sort order of the processor detail |
| BYType | rows. The keywords have the following meanings: |
| BYStat | |
| | BYAddr Sorts the processor detail rows in |
| | ascending CPU address order. This |
| | is the default. |
| | |
| | BYType Sorts the processor detail rows by |
| | Type sequence CP, IIP, and IFA, by |
| | Status sequence of ONLINE, PARK-P, |
| | PARKED, and OFFLIN, and by ascending |
| | CPU address. |
| | |
| | BYStatus Sorts the processor detail rows by |
| | Status sequence of ONLINE, PARK-P, |
| | PARKED, and OFFLIN, by Type sequence |
| | CP, IIP, and IFA, and by ascending |
| | CPU address. |
+---------------+-----------------------------------------------------+
| PVtmod | Controls whether or not an attempt will be made |
| NOPVtmod | to determine the module name and offset within the |
| | module for an EXOPSW34 address that is in the PVT |
| | or E-PVT region. The default is NOPVTMOD. If the |
| | LOCAL or CMS lock is held on the processor this |
| | option will be treated as though NOPVTMOD were |
| | specified. |
+---------------+-----------------------------------------------------+
| XSdata | Controls whether or not cross system data |
| XSystem | collection is to be forced on or off for this |
| NOXSdata | execution. If none of these keywords are specified |
| NOXSystem | then the XSDATA profile setting will be used. |
| | The use of any of these keywords does not alter |
| | the XSDATA profile setting. Note that none of |
| | these keywords are supported on the CPU command |
| | OPTIONS subcommand. |
+---------------+-----------------------------------------------------+
| RESET | Resets all options to their initial default values. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_CPU. This keyword is only valid |
| | when the product is running under a TSO CLIST or |
| | REXX EXEC. The EXTRACT keyword can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+---------------+-----------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Options | Lists the current effective options. These |
| | options can be the original initial defaults, |
| | defaults overridden with the OPTIONS subcommand, |
| | or options specified on the CPU command. |
+------------------+--------------------------------------------------+
| HdwrName | The hardware name of the processor configuration.|
| | When XSDATA is YES this value is displayed in |
| | the data rows as a field with the same name. |
+------------------+--------------------------------------------------+
| LparName | The LPAR name of the processor configuration. |
| | When XSDATA is YES this value is displayed in |
| | the data rows as a field with the same name. |
+------------------+--------------------------------------------------+
| VmUserId | The VM user ID of the virtual machine of which |
| | this MVS image is a guest. |
| | When XSDATA is YES this value is displayed in |
| | the data rows as a field with the same name. |
+------------------+--------------------------------------------------+
| HiperDsp | The status of HiperDispatching. Values can be |
| | "n/a" (not available), DISABLED, and ENABLED. |
| | When XSDATA is YES this value is displayed in |
| | the data rows as a field with the same name. |
+------------------+--------------------------------------------------+
| View | The processor view as defined by the PROCVIEW |
| | parameter of the LOADxx system parmlib member. |
| | |
| | Possible values are: |
| | |
| | CPU - A processor represents a single CPU. |
| | |
| | CORE - Simultaneous Multithreading (SMT) |
| | is enabled. A CORE represents |
| | multiple CPU's, or threads. |
+------------------+--------------------------------------------------+
| MT | The maximum number of CPU's that can "fit" |
| | on a CORE. This field is blank if SMT is not |
| | enabled. |
+------------------+--------------------------------------------------+
| MTCP | The current multithreading (MT) mode for |
| | standard CP cores. This field is blank if SMT |
| | is not enabled. |
+------------------+--------------------------------------------------+
| MTzIIP | The current multithreading (MT) mode for |
| | Integrated Information Processors (IIP) cores. |
| | This field is blank if SMT is not enabled. |
+------------------+--------------------------------------------------+
| Interval | The interval, in seconds, used for the busy |
| | percentage calculations. The time between two |
| | consecutive screen refreshes or two seconds, |
| | whichever is larger, is used. |
| | When XSDATA is YES this value is displayed in |
| | the data rows as field "Intvl". |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Id | The CORE identifier, or ALL. When the view |
| | is CPU, this will be the same value as the |
| | CPU address. When the view is CORE, there will |
| | be multiple CPU addresses for each CORE. |
| | |
| | The ALL lines are special rows present to |
| | display the average core percentage for all |
| | cores, or all cores of a single type. |
+------------------+--------------------------------------------------+
| Addr | The CPU address or ALL. The ALL lines are |
| | special rows present to display the average |
| | processor percentage for all processors, or all |
| | processors of a single type. |
+------------------+--------------------------------------------------+
| Type | Processor type. |
| | Possible values are: |
| | |
| | ALL Summary line for all processors of |
| | all types. |
| | |
| | SP Summary line for all special purpose |
| | processor types (IIP and IFA). |
| | |
| | CP A standard processor |
| | |
| | IFA An Integrated Facility for |
| | Applications processor. |
| | |
| | IIP An IIP processor. |
| | |
| | UNKN The processor type could not be |
| | determined. |
+------------------+--------------------------------------------------+
| Status | Processor status. |
| | Possible values are: |
| | |
| | ONLINE The processor is online. |
| | |
| | PARK-P The processor is online but is in |
| | the process of being parked. |
| | |
| | PARKED The processor is parked. |
| | |
| | OFFLIN The processor is offline. |
| | |
| | NOTAVL The processor is not available, |
| | meaning SMT is enabled, but |
| | multithreading for this processor |
| | core type is set to a value less |
| | than MT (max threads per core). |
+------------------+--------------------------------------------------+
| Busy% | The processor busy percentage. |
+------------------+--------------------------------------------------+
| BusyGraph | A graphical display of the processor busy |
| | percentage. The color of this field can change |
| | based on the status shown in the BusyStat field. |
+------------------+--------------------------------------------------+
| Core | Core indicator (can be used to identify rows |
| | containing LPAR data). |
| | Possible values are: |
| | |
| | ALL Summary line for all processors of |
| | the type indicated. |
| | |
| | CORE The row data is for thread 0 of a |
| | processor core. |
+------------------+--------------------------------------------------+
| Pz | The polarization state of an online or parked |
| | processor. This field is blank for summary ALL |
| | rows, for processors that are not online or |
| | parked, and for online processors or parked |
| | processors when the polarization state could |
| | not be determined. |
| | |
| | Possible values are: |
| | |
| | HZ Horizontal polarization. |
| | |
| | VL Vertical polarization with low |
| | entitlement. |
| | |
| | VM Vertical polarization with medium |
| | entitlement. |
| | |
| | VH Vertical polarization with high |
| | entitlement. |
+------------------+--------------------------------------------------+
| Onl | Count of online processors for a summary ALL |
| | row. Blank for a processor detail row. |
+------------------+--------------------------------------------------+
| Par | Count of parked processors for a summary ALL |
| | row. Blank for a processor detail row. |
+------------------+--------------------------------------------------+
| Off | Count of offline processors for a summary ALL |
| | row. Blank for a processor detail row. |
+------------------+--------------------------------------------------+
| Unk | Count of processors whose status could not be |
| | detemined for a summary ALL row. Blank for a |
| | processor detail row. |
+------------------+--------------------------------------------------+
| Tot | Total processors for a summary ALL row. Blank |
| | for a processor detail row. |
+------------------+--------------------------------------------------+
| Mode | The mode of execution. |
| | Possible values are: |
| | |
| | WAIT Enabled wait state |
| | DISP Dispatcher is active |
| | SRB System request block |
| | TASK Task (TCB) |
+------------------+--------------------------------------------------+
| State | State taken from the EXOPSW1. |
| | Possible values are: |
| | |
| | PROB Problem state |
| | SUP Supervisor state |
| | |
| | This field will be blank when the Mode is WAIT. |
+------------------+--------------------------------------------------+
| Ky | Key taken from the EXOPSW1. |
| | This field will be blank when the Mode is WAIT. |
+------------------+--------------------------------------------------+
| AM | Addressing mode taken from the EXOPSW1. |
| | Possible values are: |
| | |
| | 24 24-bit addressing mode |
| | 31 31-bit addressing mode |
| | 64 64-bit addressing mode |
| | |
| | This field will be blank when the Mode is WAIT. |
+------------------+--------------------------------------------------+
| ASC | Address space control mode taken from the |
| | EXOPSW1. Possible values are: |
| | |
| | PRIM Primary mode |
| | SEC Secondary mode |
| | AR Access register mode |
| | HOME Home mode |
| | REAL Real mode (DAT off) |
| | |
| | This field will be blank when the Mode is WAIT. |
+------------------+--------------------------------------------------+
| PASN | Primary address space number (ASID). |
| | This field will be blank when the Mode is WAIT. |
+------------------+--------------------------------------------------+
| PJobName | Primary job name. |
| | This field will be blank when the Mode is WAIT. |
+------------------+--------------------------------------------------+
| SASN | Secondary address space number (ASID). |
| | This field will be blank when the Mode is WAIT |
| | or when the SASN is the same as the PASN. |
+------------------+--------------------------------------------------+
| SJobName | Secondary job name. |
| | This field will be blank when the Mode is WAIT |
| | or when the SASN is the same as the PASN. |
+------------------+--------------------------------------------------+
| HASN | Home address space number (ASID). |
| | This field will be blank when the Mode is WAIT |
| | or when the HASN is the same as the PASN. |
+------------------+--------------------------------------------------+
| HJobName | Home job name. |
| | This field will be blank when the Mode is WAIT |
| | or when the HASN is the same as the PASN. |
+------------------+--------------------------------------------------+
| Module | Module associated with EXOPSW34 next sequential |
| | instruction address. If the NSI address is in |
| | the private area then the search for the module |
| | will be in the PASN address space, unless the |
| | ASC mode is HOME in which case the search will |
| | be in the HASN if it is not the same as the |
| | PASN. This field will be blank if the EXOPSW34 |
| | address is in the PVT or E-PVT region and the |
| | NOPVTMOD option is in effect or if the LOCAL |
| | or CMS lock is held on the processor. |
+------------------+--------------------------------------------------+
| Offset | Offset of EXOPSW34 next sequential instruction |
| | into the associated module (Module field above). |
| | This field will be blank if the EXOPSW34 address |
| | is in the PVT or E-PVT region and the NOPVTMOD |
| | option is in effect or if the LOCAL or CMS lock |
| | lock is held on the processor. |
+------------------+--------------------------------------------------+
| Region | Region associated with EXOPSW34 next sequential |
| | instruction address. |
+------------------+--------------------------------------------------+
| EXOPSW1 | The 1st word of the PSW of interrupted work. |
+------------------+--------------------------------------------------+
| EXOPSW34 | The 3rd and 4th words of the PSW of interrupted |
| | work. This is the next sequential instruction |
| | address (NSI). |
+------------------+--------------------------------------------------+
| ASCB | The ASCB address. |
+------------------+--------------------------------------------------+
| TCB | The TCB address. |
+------------------+--------------------------------------------------+
| PCCAV | The virtual PCCA address. |
+------------------+--------------------------------------------------+
| PCCAR | The real PCCA address. |
+------------------+--------------------------------------------------+
| LCCAV | The virtual LCCA address. |
+------------------+--------------------------------------------------+
| LCCAR | The real LCCA address. |
+------------------+--------------------------------------------------+
| LCCXV | The virtual LCCX address. |
+------------------+--------------------------------------------------+
| LCCXR | The real LCCX address. |
+------------------+--------------------------------------------------+
| PSAV | The virtual PSA address. |
+------------------+--------------------------------------------------+
| PSAR | The real PSA address. |
+------------------+--------------------------------------------------+
| PSASUPER | The contents of the PSASUPER field. |
+------------------+--------------------------------------------------+
| PSACLHS | The contents of the PSACLHS field (the current |
| | locks held string). |
+------------------+--------------------------------------------------+
| PSACLHSE | The contents of the PSACLHSE field (the current |
| | locks held string extension). |
+------------------+--------------------------------------------------+
| CPUId | The CPU identifier. |
+------------------+--------------------------------------------------+
| Prefix | The contents of the prefix register. |
+------------------+--------------------------------------------------+
| TODClock | The time-of-day clock value. |
+------------------+--------------------------------------------------+
| Timer | The CPU timer value. |
+------------------+--------------------------------------------------+
| ClockComparator | The clock comparator value. |
+------------------+--------------------------------------------------+
| CR0 | The contents of control register 0. |
+------------------+--------------------------------------------------+
| CR1 | The contents of control register 1. |
+------------------+--------------------------------------------------+
| CR2 | The contents of control register 2. |
+------------------+--------------------------------------------------+
| CR3 | The contents of control register 3. |
+------------------+--------------------------------------------------+
| CR4 | The contents of control register 4. |
+------------------+--------------------------------------------------+
| CR5 | The contents of control register 5. |
+------------------+--------------------------------------------------+
| CR6 | The contents of control register 6. |
+------------------+--------------------------------------------------+
| CR7 | The contents of control register 7. |
+------------------+--------------------------------------------------+
| CR8 | The contents of control register 8. |
+------------------+--------------------------------------------------+
| CR9 | The contents of control register 9. |
+------------------+--------------------------------------------------+
| CR10 | The contents of control register 10. |
+------------------+--------------------------------------------------+
| CR11 | The contents of control register 11. |
+------------------+--------------------------------------------------+
| CR12 | The contents of control register 12. |
+------------------+--------------------------------------------------+
| CR13 | The contents of control register 13. |
+------------------+--------------------------------------------------+
| CR14 | The contents of control register 14. |
+------------------+--------------------------------------------------+
| CR15 | The contents of control register 15. |
+------------------+--------------------------------------------------+
| LPAR% | The processor busy percentage from the LPAR |
| | point of view. The LPAR busy percent is at |
| | the processor core level, so this value only |
| | appears on the first row (thread 0) for the |
| | core Id as well as the ALL rows. |
+------------------+--------------------------------------------------+
| LPARGraph | A graphical display of the processor busy |
| | percentage from the LPAR point of view. The |
| | color of this field can change based on the |
| | status shown in the LPARStat field. |
+------------------+--------------------------------------------------+
| Wtc | Specifies WTC if WAIT=COMPLETION is specified |
| | for the partition, otherwise it is blank. |
+------------------+--------------------------------------------------+
| Cap | Specifies CAP if defined as capped, otherwise it |
| | is blanks. |
+------------------+--------------------------------------------------+
| PWt | The processing weight of the logical partition. |
+------------------+--------------------------------------------------+
| Ded | Specifies DED if the partition uses dedicated |
| | processors. |
+------------------+--------------------------------------------------+
| BusyStat | The CPU busy status based on threshold |
| | definitions. |
+------------------+--------------------------------------------------+
| LPARStat | The CPU LPAR status based on threshold |
| | definitions. |
+------------------+--------------------------------------------------+
| PathName | The OpenMVS path name associated with EX-OPSW2 |
| | next sequential instruction above. |
+------------------+--------------------------------------------------+
| The following fields are only displayed when XSDATA is YES. |
+------------------+--------------------------------------------------+
| HdwrName | The hardware name of the processor configuration.|
| | When XSDATA is NO this value is displayed in |
| | the information section under the same name. |
+------------------+--------------------------------------------------+
| LparName | The LPAR name of the processor configuration. |
| | When XSDATA is NO this value is displayed in |
| | the information section under the same name. |
+------------------+--------------------------------------------------+
| VmUserId | The VM user ID of the virtual machine of which |
| | this MVS image is a guest. |
| | When XSDATA is NO this value is displayed in |
| | the information section under the same name. |
+------------------+--------------------------------------------------+
| HiperDsp | The status of HiperDispatching. |
| | Possible values are: |
| | |
| | "n/a" (not available) |
| | DISABLED |
| | ENABLED |
| | |
| | When XSDATA is NO this value is displayed in |
| | the information section under the same name. |
+------------------+--------------------------------------------------+
| View | The processor view. |
| | Possible values are: |
| | |
| | CPU - A processor represents a single CPU. |
| | |
| | CORE - Simultaneous Multithreading (SMT) |
| | is enabled. A CORE represents |
| | multiple CPU's, or threads. |
| | |
| | When XSDATA is NO this value is displayed in |
| | the information section under the same name. |
+------------------+--------------------------------------------------+
| MT | The maximum number of CPU's that can "fit" |
| | on a CORE. If SMT is not enabled, this field |
| | is blank. |
| | When XSDATA is NO this value is displayed in |
| | the information section under the same name. |
+------------------+--------------------------------------------------+
| MTCP | The current multithreading (MT) mode for |
| | standard CP cores. This field is blank if SMT |
| | is not enabled. |
| | When XSDATA is NO this value is displayed in |
| | the information section under the same name. |
+------------------+--------------------------------------------------+
| MTzIIP | The current multithreading (MT) mode for |
| | Integrated Information Processors (IIP) cores. |
| | This field is blank if SMT is not enabled. |
| | When XSDATA is NO this value is displayed in |
| | the information section under the same name. |
+------------------+--------------------------------------------------+
| Intvl | The interval, in seconds, used for the busy |
| | percentage calculations. The time between two |
| | consecutive screen refreshes or two seconds, |
| | whichever is larger, is used. |
| | When XSDATA is NO this value is displayed in |
| | the information section as "Interval". |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands


+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| ONline | Issues an MVS CONFIG CPU(addr),ONLINE command to bring |
| | an offline processor online. |
+----------+----------------------------------------------------------+
| OFfline | Issues an MVS CONFIG CPU(addr),OFFLINE command to take |
| | an online processor offline. |
+----------+----------------------------------------------------------+

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Select | Invokes the OUTPUT command to display job output for the |
| | job active on the selected processor. The job name and |
| | number used will be for the PASN. |
+----------+----------------------------------------------------------+
| Plot | Invokes the PLOT command to display a plot of the CPU |
| | busy percentage for the selected processor. |
+----------+----------------------------------------------------------+
| Menu | Invokes a MENU ADDRSPC command. |
+----------+----------------------------------------------------------+
| Any | Any valid primary command can be issued as a CPU line |
| valid | command. If the specified command is a memory switch |
| primary | sensitive command (such as DUMP or JPA), then an ASID |
| command | command is internally generated to switch to the |
| | selected address space before invoking the requested |
| | command. If the specified command supports a jobname |
| | and jobnumber parameter as the first two parameters |
| | (such as OUTPUT and STEPSUM) and no other parameters |
| | were entered in the line command input area, then the |
| | requested command is invoked with the jobname and number |
| | from the selected address space. All other commands are |
| | invoked as if they had been entered on the command input |
| | line. The job name and number used will be for the PASN. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Function |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
| OPTIONS | Set and display CPU options. |
+----------+----------------------------------------------------------+

OPTIONS Subcommand

The OPTIONS subcommand is used to set CPU command


processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [options] |
+---------------+-----------------------------------------------------+
The following table lists and explains the valid OPTIONS parameter
values. Any number of values can be specified in any order. The
current settings of all options are always displayed in the
information area. Options changed with the OPTIONS subcommand are
saved in your profile as the default options for the CPU command.
These defaults can be overridden by specifiying the same option
keywords on the CPU command. Options changed in this manner are
not saved.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| SUmmary | Controls whether or not the summary ALL lines |
| NOSUmmary | will be displayed. The default is SUMMARY. |
+---------------+-----------------------------------------------------+
| Detail | Controls whether or not the detail processor lines |
| NODetail | will be displayed. The default is DETAIL. |
+---------------+-----------------------------------------------------+
| Cp | Controls whether or not CP processors will be |
| NOCp | included in the display. The default is CP. |
+---------------+-----------------------------------------------------+
| Sp | Controls whether or not the ALL SP line will be |
| NOSp | displayed. The ALL SP line displays the total of |
| | special purpose processors - IIPs and IFAs. |
+---------------+-----------------------------------------------------+
| IFa | Controls whether or not IFA processors will be |
| NOIFa | included in the display. The default is IFA. |
+---------------+-----------------------------------------------------+
| IIp | Controls whether or not IIP processors will be |
| NOIIp | included in the display. The default is IIP. |
+---------------+-----------------------------------------------------+
| Offline | Controls whether or not offline processors will be |
| NOOffline | included in the display. The default is OFFLINE. |
+---------------+-----------------------------------------------------+
| Parked | Controls whether or not parked processors will be |
| NOParked | included in the display. The default is PARKED. |
+---------------+-----------------------------------------------------+
| BYAddr | Controls the sort order of the processor detail |
| BYType | rows. The keywords have the following meanings: |
| BYStat | |
| | BYAddr Sorts the processor detail rows in |
| | ascending CPU address order. This |
| | is the default. |
| | |
| | BYType Sorts the processor detail rows by |
| | Type sequence CP, IIP, and IFA, by |
| | Status sequence of ONLINE, PARK-P, |
| | PARKED, and OFFLIN, and by ascending |
| | CPU address. |
| | |
| | BYStatus Sorts the processor detail rows by |
| | Status sequence of ONLINE, PARK-P, |
| | PARKED, and OFFLIN, by Type sequence |
| | CP, IIP, and IFA, and by ascending |
| | CPU address. |
+---------------+-----------------------------------------------------+
| PVtmod | Controls whether or not an attempt will be made |
| NOPVtmod | to determine the module name and offset within the |
| | module for an EXOPSW34 address that is in the PVT |
| | or E-PVT region. The default is NOPVTMOD. If the |
| | LOCAL or CMS lock is held on the processor this |
| | option will be treated as though NOPVTMOD were |
| | specified. |
+---------------+-----------------------------------------------------+
| RESET | Resets all options to their initial default values. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_CPU. This keyword is only valid |
| | when the product is running under a TSO CLIST or |
| | REXX EXEC. The EXTRACT keyword can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+---------------+-----------------------------------------------------+

Messages

CPU$002E [linecmd] not valid for CPU [addr]

Informational only.

CPU$003E [linecmd] not valid for job [jobnm]

Informational only.

CPU$004W [linecmd] not valid for only active processor

Informational only.
CPUSUM

CPUSUM Command

The CPUSUM command displays processor information collected by the MVS


Data Collector averaged over a specified interval up to an hour.

The data for this command requires the following to be active:

* MVS Data Collector - Task name MVSDATA


* Scheduled Event Function - MVSDATA-CPUS
* MVS CPU Metric - MVS_CPU_LparBusy%
* MVS CPU Metric - MVS_CPU_RelativeShare%

CPUSUM will not display information when you are executing under VM.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+---------------+-----------------------------------------------------+
| | |
| CPUSUM | [ All | NOAll ] |
| | [ CP | NOCP ] |
| | [ SP | NOSP ] |
| | [ IFA | NOIFA ] |
| | [ IIP | NOIIP ] |
| | |
| | [ INTerval minutes ] |
| | |
| | [ NOXSdata | XSdata ] |
| | [ NOXSystem | XSystem ] |
| | |
| | [ RESET ] |
| | |
| | [ EXTRACT ] |
| | |
+---------------+-----------------------------------------------------+

Parameters

The following table lists and explains the valid CPUSUM options
parameter values. Any number of the values can be specified in any
order. The options specified on the CPUSUM command are not saved from
one invocation of the CPUSUM command to the next. Options specified
with the OPTIONS subcommand are saved in your profile. These are then
the defaults that the CPUSUM options will override. The defaults listed
in the table below are the initial defaults. Your default may be
different if you have used the OPTIONS subcommand.

If you have tried various combinations of CPUSUM command options and


have arrived at a set that you would like to save as your defaults, you
can enter the OPTIONS subcommand with no operands. This will save the
current set of options as your defaults.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| NOAll | Controls whether or not the summary ALL lines are |
| All | displayed. The default is ALL. |
+---------------+-----------------------------------------------------+
| CP | Controls whether or not Type CP lines will be |
| NOCP | displayed. The default is CP. |
+---------------+-----------------------------------------------------+
| SP | Controls whether or not Type IFA, IIP, and SP lines |
| NOSP | are displayed. The default SP. |
+---------------+-----------------------------------------------------+
| IFA | Controls whether or not Type IFA lines will be |
| NOIFA | displayed. The default is IFA. |
+---------------+-----------------------------------------------------+
| IIP | Controls whether or not Type IIP lines will be |
| NOIIP | displayed. The default is IIP. |
+---------------+-----------------------------------------------------+
| INTerval | The amount of time, in minutes, of data collection |
| | intervals that are averaged to compute processor |
| | utilization. |
| | |
| | Valid values are: |
| | |
| | Default: 1 |
| | Minimum: 1 |
| | Maximum: 60 |
+---------------+-----------------------------------------------------+
| XSdata | Controls whether or not cross system data |
| XSystem | collection is to be forced on or off for this |
| NOXSdata | execution. If none of these keywords are specified |
| NOXSystem | then the XSDATA profile setting will be used. |
| | The use of any of these keywords does not alter |
| | the XSDATA profile setting. Note that none of |
| | these keywords are supported on the CPUSUM command |
| | OPTIONS subcommand. |
+---------------+-----------------------------------------------------+
| RESET | Resets all options to their initial default values. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_CPUSUM. This keyword is only valid |
| | when the product is running under a TSO CLIST or |
| | REXX EXEC. The EXTRACT keyword can be specified |
| | alone or in combination with any other OPTIONS |
| | keyword. |
+---------------+-----------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Options | Lists the current effective options. These |
| | options can be the original initial defaults, |
| | defaults overridden with the OPTIONS subcommand, |
| | or options specified on the CPUSUM command. |
+------------------+--------------------------------------------------+
| HdwrName | The hardware name of the processor configuration.|
| | Displays the home partition in cross system mode.|
+------------------+--------------------------------------------------+
| LparName | The LPAR name of the processor configuration. |
| | Displays the home partition in cross system mode.|
+------------------+--------------------------------------------------+
| Interval | The amount of data collection intervals that are |
| | averaged to compute the processor utilization. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Type | The processor type. |
| | |
| | Possible values are: |
| | |
| | ALL Summary line for all processors of |
| | all types. |
| | |
| | SP Summary line for all special purpose |
| | processor types (IIP and IFA). |
| | |
| | CP A standard processor. |
| | |
| | IFA An Integrated Facility for |
| | Applications processor. |
| | |
| | IIP An IIP processor. |
| | |
+------------------+--------------------------------------------------+
| Addr | The processor address. |
| | |
| | The processor address can also be the keyword |
| | ALL which are special rows present to display |
| | the average processor percentage for all |
| | processors or all processors of a single type. |
+------------------+--------------------------------------------------+
| Cnt | The count of processors included when the Addr |
| | value is ALL. |
+------------------+--------------------------------------------------+
| Status | The processor status. |
| | |
| | Possible values are: |
| | |
| | OFFLINE The processor is offline. |
| | ONLINE The processor is online. |
+------------------+--------------------------------------------------+
| Busy% | The processor busy percentage. |
| | |
| | Value from MVS Data Collector metric: |
| | MVS_CHAN_LparBusy% |
+------------------+--------------------------------------------------+
| Busy-Graph | A graphic display of processor busy percentage. |
+------------------+--------------------------------------------------+
| RShr% | The processor busy percentage relative to the |
| | shared processing weights in the central |
| | processing complex. |
| | |
| | This field is not populated for summary rows |
| | where multiple processor types are combined, |
| | such as ALL and SP. |
| | |
| | See this help topic for more information on how |
| | this is calculated. |
| | |
| | Value from MVS Data Collector metric: |
| | MVS_CPU_RelativeShare% |
+------------------+--------------------------------------------------+
| RShr-Graph | A graphic display of processor busy percentage |
| | relative to the shared processing weights in the |
| | central processing complex. |
| | |
| | This field is not populated for summary rows |
| | where multiple processor types are combined, |
| | such as ALL and SP. |
| | |
| | See this help topic for more information on how |
| | this is calculated. |
+------------------+--------------------------------------------------+
| Pz | The polarization state of an online processor. |
| | This field will be blank on all other rows. |
| | |
| | Possible values are: |
| | |
| | HZ Horizontal polarization. |
| | VL Vertical polarization with low |
| | entitlement. |
| | VM Vertical polarization with medium |
| | entitlement. |
| | VH Vertical polarization with high |
| | entitlement. |
| | |
+------------------+--------------------------------------------------+
| WtC | This value is WTC if WAIT=COMPLETION is specified|
| | for the partition. Otherwise, it is blanks. |
+------------------+--------------------------------------------------+
| Cap | CAP if the processor is capped. |
+------------------+--------------------------------------------------+
| Wlm | WLM if the processor is WLM capped. |
+------------------+--------------------------------------------------+
| PWt | The processing weight of the logical partition or|
| | DED if the partition uses dedicated processors. |
| | |
| | When the processor's Addr field is ALL and Type |
| | field is not ALL or SP, this field represents |
| | the processing weight across logical online |
| | processors of the same type. |
+------------------+--------------------------------------------------+
| CWt | Current weight. |
| | |
| | When the processor's Addr field is ALL and Type |
| | field is not ALL or SP, this field represents |
| | the current weight across logical online |
| | processors of the same type. |
+------------------+--------------------------------------------------+
| MnW | Minimum weight. |
| | |
| | When the processor's Addr field is ALL and Type |
| | field is not ALL or SP, this field represents |
| | the minimum weight across logical online |
| | processors of the same type. |
+------------------+--------------------------------------------------+
| MxW | Maximum weight. |
| | |
| | When the processor's Addr field is ALL and Type |
| | field is not ALL or SP, this field represents |
| | the maximum weight across logical online |
| | processors of the same type. |
+------------------+--------------------------------------------------+
| PmaWt | Pricing management adjustment weight. |
| | |
| | When the processor's Addr field is ALL and Type |
| | field is not ALL or SP, this field represents |
| | the price management adjustment weight across |
| | logical online processors of the same type. |
+------------------+--------------------------------------------------+
| PolarWt | Polarization weight. This field will be blank |
| | if vertical polarization is not in effect. |
| | |
| | When the processor's Addr field is ALL and Type |
| | field is not ALL or SP, this field represents |
| | the polarization weight across logical online |
| | processors of the same type. |
| | |
| | Polarization weight is multiplied by 4096 |
| | to provide higher granularity. |
+------------------+--------------------------------------------------+
| MaxLU | Maximum licensing units. The maximum number of |
| | processor licensing units that an LPAR may |
| | consume per unit time, on average. A licensing |
| | unit is defined as millions of service units |
| | (MSU). |
+------------------+--------------------------------------------------+
| PNo | The partition number in decimal format. |
| | The SMF70LPN is a partition number that is |
| | assigned internally alphabetically, and there is |
| | no control over the value. |
+------------------+--------------------------------------------------+
| PId | The logical partition identifier in hexadecimal. |
| | The SMF70UPI is the Partition ID which can be |
| | seen and updated on the HMC (General section). |
+------------------+--------------------------------------------------+
| PName | The partition name. |
+------------------+--------------------------------------------------+
| LpcName | Name of the logical partition cluster that |
| | contains this logical partition. |
+------------------+--------------------------------------------------+
| SysName | The system name declared for this logical |
| | partition. |
+------------------+--------------------------------------------------+
| GrpName | Name of the group for which group capacity |
| | with respect to the group MLU is measured. |
+------------------+--------------------------------------------------+
| GrpLU | Group maximum licensing units. The maximum |
| | number of processor licensing units for the |
| | group of logical partitions identified by |
| | having the same group name, of which this |
| | logical partition is a member, and which may |
| | be consumed per unit of time, on average. |
+------------------+--------------------------------------------------+
| CStor | The amount of central storage currently online |
| | to this logical partition. |
+------------------+--------------------------------------------------+
| EStor | The amount of expanded storage currently online |
| | to the logical partition. |
+------------------+--------------------------------------------------+
| BusyStat | The processor busy status based on threshold |
| | definitions. |
+------------------+--------------------------------------------------+
| RShrStat | The processor relative share busy status based |
| | on threshold definitions. |
+------------------+--------------------------------------------------+
| PlotArg | Argument to be passed on PLOT and GRAPH line |
| | commands. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| GCpu | Invokes the GRAPH command to display a plot of the |
| | LPAR CPU busy pct (core) for the selected processor. |
+----------+----------------------------------------------------------+
| GRsh | Invokes the GRAPH command to display a plot of the |
| | CPU Relative share pct for the selected processor. |
+----------+----------------------------------------------------------+
| PCpu | Invokes the PLOT command to display a plot of the |
| | LPAR CPU busy pct (core) for the selected processor. |
+----------+----------------------------------------------------------+
| PRsh | Invokes the PLOT command to display a plot of the |
| | CPU Relative share pct for the selected processor. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Function |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
| OPTIONS | Set and display CPUSUM options. |
+----------+----------------------------------------------------------+

OPTIONS Subcommand

The OPTIONS subcommand is used to set and display CPUSUM command


processing options.
OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [options] |
+---------------+-----------------------------------------------------+

The following table lists and explains the valid OPTIONS parameter
values. Any number of the values can be specified in any order. The
current settings of all options are always displayed in the information
area. Options changed with the OPTIONS subcommand are saved in your
profile as the default options for the CPUSUM command. These defaults
can be overridden by specifying the same option keywords on the CPUSUM
command. Options changed in this manner are not saved.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| NOAll | Controls whether or not the summary ALL lines are |
| All | displayed. The default is ALL. |
+---------------+-----------------------------------------------------+
| CP | Controls whether or not Type CP lines will be |
| NOCP | displayed. The default is CP. |
+---------------+-----------------------------------------------------+
| SP | Controls whether or not Type IFA, IIP, and SP lines |
| NOSP | are displayed. The default SP. |
+---------------+-----------------------------------------------------+
| IFA | Controls whether or not Type IFA lines will be |
| NOIFA | displayed. The default is IFA. |
+---------------+-----------------------------------------------------+
| IIP | Controls whether or not Type IIP lines will be |
| NOIIP | displayed. The default is IIP. |
+---------------+-----------------------------------------------------+
| INTerval | The amount of time, in minutes, of data collection |
| | intervals that are averaged to compute processor |
| | utilization. |
| | |
| | Valid values are: |
| | |
| | Default: 1 |
| | Minimum: 1 |
| | Maximum: 60 |
+---------------+-----------------------------------------------------+
| RESET | Resets all options to their initial default values. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_CPUSUM. This keyword is only valid |
| | when the product is running under a TSO CLIST or |
| | REXX EXEC. The EXTRACT keyword can be specified |
| | alone or in combination with any other OPTIONS |
| | keyword. |
+---------------+-----------------------------------------------------+
CREMOTE

CREMOTE Command

The CREMOTE command displays a list of remote system connections


defined to CICS.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CREMOTE | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,SysID,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| SysID | The SysID defined to the remote connection. |
| | This is also referred to as the connection name. |
+------------------+--------------------------------------------------+
| Netname | The network applid of the remote CICS. |
+------------------+--------------------------------------------------+
| ConnStatus | The current state of the connection between |
| | CICS and a remote system. |
| | Possible values are: |
| | |
| | blank |
| | ACQUIRED |
| | OBTAINING |
| | FREEING |
| | AVAILABLE |
| | RELEASED |
| | |
+------------------+--------------------------------------------------+
| SysType | The system type. |
| | Possible values are: |
| | |
| | LOCAL - Local entry |
| | FULL-SYS - Full system entry |
| | INDIRECT - A remote system for which no |
| | direct link has been defined |
| | |
+------------------+--------------------------------------------------+
| LUType | The Logical Unit type. This field will be blank |
| | for SysType=LOCAL. |
| | Possible values are: |
| | |
| | LUC LUC links and sessions |
| | LU6 LUTYPE 6.1 CICS-IMS links and sessions |
| | MRO MRO links and sessions |
| | |
+------------------+--------------------------------------------------+
| Inservice | The current service status. |
| | Possible values are: |
| | |
| | INSERVICE - In service |
| | OUTSERVICE - Out of service |
| | |
+------------------+--------------------------------------------------+
| AccMethod | The access method in use for this connection. |
| | This field will be blank for SysType=LOCAL. |
| | Possible values are: |
| | |
| | VTAM |
| | IRC |
| | XM |
| | INDIRECT |
| | XCF |
| | RCONNECT |
| | |
+------------------+--------------------------------------------------+
| Protocol | The protocol in use if this is a VTAM or |
| | external CICS interface connection. |
| | Possible values are: |
| | |
| | APPC |
| | EXCI |
| | LU61 |
| | |
+------------------+--------------------------------------------------+
| XLNStat | The status of the exchange lognames (XLN) |
| | process. This is valid for Protocol=APPC. |
| | Possible values are: |
| | |
| | XOK - The exchange lognames process has |
| | completed. |
| | XNO - The exchange lognames process has not |
| | completed. |
| | |
+------------------+--------------------------------------------------+
| PriSess | The number of primary sessions. |
+------------------+--------------------------------------------------+
| SecSess | The number of secondary sessions. |
+------------------+--------------------------------------------------+
| SecSessHWM | The peak number of contention winner sessions |
| | that were in use. |
+------------------+--------------------------------------------------+
| AllocLink | The total number of allocates for this |
| | connection. |
+------------------+--------------------------------------------------+
| AllocQueue | The current number of allocate requests |
| | queued for this connection. |
+------------------+--------------------------------------------------+
| AllocHWM | The peak number of allocate requests queued |
| | for this connection. |
+------------------+--------------------------------------------------+
| FCReqs | The number of file control requests function |
| | shipped across the connection. |
+------------------+--------------------------------------------------+
| ICReqs | The total number of interval control requests |
| | function shipped across the connection. |
+------------------+--------------------------------------------------+
| PCReqs | The total number of program control requests |
| | function shipped across the connection. |
+------------------+--------------------------------------------------+
| TDReqs | The number of transient data requests |
| | function shipped across the connection. |
+------------------+--------------------------------------------------+
| TSReqs | The number of temporary storage requests |
| | function shipped across the connection. |
+------------------+--------------------------------------------------+
| TCReqs | The total number of transaction routing |
| | requests sent across the connection. |
+------------------+--------------------------------------------------+
| DLReqs | The number of DLI requests sent across the |
| | connection. |
+------------------+--------------------------------------------------+
| Bids | The total number of bids sent. |
+------------------+--------------------------------------------------+
| BidsHWM | The high water mark of bids in progress. |
+------------------+--------------------------------------------------+
| ATIPrim | The number of queued allocate requests that |
| | have been satisfied by loser sessions. |
+------------------+--------------------------------------------------+
| ATISec | The number of queued allocate requests that |
| | have been satisfied by winner sessions. |
+------------------+--------------------------------------------------+
| FailLink | The number of allocate requests that failed |
| | due to the connection being released, out of |
| | service, or with a closed mode group. |
+------------------+--------------------------------------------------+
| FailOther | The number of allocate requests that failed |
| | due to a session not being currently available |
| | for use. |
+------------------+--------------------------------------------------+
| Requests | The total number of requests attempted. |
+------------------+--------------------------------------------------+
| Rejects | The number of requests rejected. |
+------------------+--------------------------------------------------+
| Deletes | The number of deletes. |
+------------------+--------------------------------------------------+
| ReqsHWM | The peak number of concurrent requests. |
+------------------+--------------------------------------------------+
| ReqsAtHWM | The number of times that the number of requests |
| | has been at ReqsHWM. |
+------------------+--------------------------------------------------+
| IndSystem | The name of another connection that defines |
| | an intermediate system used to relay |
| | communications between this system and the |
| | remote system. |
+------------------+--------------------------------------------------+
| RSystem | The name that identifies the intercommunications |
| | link to the system that owns the connection. |
+------------------+--------------------------------------------------+
| RName | The name by which the APPC connection |
| | for transaction routing is known in the system |
| | or region that owns the connection. |
+------------------+--------------------------------------------------+
| RNetwork | The network name of the system that owns the |
| | connection. |
+------------------+--------------------------------------------------+
| ConnDate | Date of last connection. |
| | This is valid for LUtype MRO. |
+------------------+--------------------------------------------------+
| ConnTime | Time of last connection. |
| | This is valid for LUtype MRO. |
+------------------+--------------------------------------------------+
| DFHTCTTE | The address of the DFHTCTTE control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| ACQuired | CICS is to acquire a session with the connection |
| | name. |
| | Command issued: |
| | CICSSET CONNECT sysid ACQUIRED |
| | Equivalent: |
| | CEMT SET CONNECTION(sysid) ACQUIRED |
+------------------+--------------------------------------------------+
| BACkout | All UOWs that are shunted due to the failure of |
| | this connection are to be backed out. |
| | Command issued: |
| | CICSSET CONNECT sysid BACKOUT |
| | Equivalent: |
| | CEMT SET CONNECTION(sysid) BACKOUT |
+------------------+--------------------------------------------------+
| CANcel | AIDs queuing for this connection are to be |
| | canceled. |
| | Command issued: |
| | CICSSET CONNECT sysid CANCEL |
| | Equivalent: |
| | CEMT SET CONNECTION(sysid) CANCEL |
+------------------+--------------------------------------------------+
| COMmit | All UOWs that are shunted due to the failure of |
| | this connection are to be committed. |
| | Command issued: |
| | CICSSET CONNECT sysid COMMIT |
| | Equivalent: |
| | CEMT SET CONNECTION(sysid) COMMIT |
+------------------+--------------------------------------------------+
| ENDaff | If CICS is a member of a generic VTAM resource |
| | group, VTAM is to end an affinity owned by CICS. |
| | Command issued: |
| | CICSSET CONNECT sysid ENDAFFINITY |
| | Equivalent: |
| | CEMT SET CONNECTION(sysid) ENDAFFINITY |
+------------------+--------------------------------------------------+
| FCAncel | All AIDs, including system AIDs, that are |
| | queuing for this connection are to be canceled. |
| | Command issued: |
| | CICSSET CONNECT sysid FCANCEL |
| | Equivalent: |
| | CEMT SET CONNECTION(sysid) FCANCEL |
+------------------+--------------------------------------------------+
| FORcepur | All transactions that are running on sessions on |
| | the connected system are immediately terminated. |
| | Command issued: |
| | CICSSET CONNECT sysid FORCEPURGE |
| | Equivalent: |
| | CEMT SET CONNECTION(sysid) FORCEPURGE |
+------------------+--------------------------------------------------+
| FUOw | All UOWs shunted due to the failure of the |
| | connection are to be forced to backout or commit |
| | as specified on the transaction definition. |
| | Command issued: |
| | CICSSET CONNECT sysid FORCEUOW |
| | Equivalent: |
| | CEMT SET CONNECTION(sysid) FORCEUOW |
+------------------+--------------------------------------------------+
| INServ | A request is made to put the system in service. |
| | Command issued: |
| | CICSSET CONNECT sysid INSERVICE |
| | Equivalent: |
| | CEMT SET CONNECTION(sysid) INSERVICE |
+------------------+--------------------------------------------------+
| NOTpend | Forces all indoubt UOWs that were created by the |
| | connection before the initial start of the |
| | partner. |
| | Command issued: |
| | CICSSET CONNECT sysid NOTPENDING |
| | Equivalent: |
| | CEMT SET CONNECTION(sysid) NOTPENDING |
+------------------+--------------------------------------------------+
| OUTserv | A request is made to put the system out of |
| | service. |
| | Command issued: |
| | CICSSET CONNECT sysid OUTSERVICE |
| | Equivalent: |
| | CEMT SET CONNECTION(sysid) OUTSERVICE |
+------------------+--------------------------------------------------+
| PURge | Transactions running on the connected system |
| | are terminated. |
| | Command issued: |
| | CICSSET CONNECT sysid PURGE |
| | Equivalent: |
| | CEMT SET CONNECTION(sysid) PURGE |
+------------------+--------------------------------------------------+
| RELeased | CICS is to release a session with the logical |
| | unit represented by the connection name. |
| | Command issued: |
| | CICSSET CONNECT sysid RELEASED |
| | Equivalent: |
| | CEMT SET CONNECTION(sysid) RELEASED |
+------------------+--------------------------------------------------+
| RESync | Any UOWs shunted due to the failure of this |
| | connection are to be retried. |
| | Command issued: |
| | CICSSET CONNECT sysid RESYNC |
| | Equivalent: |
| | CEMT SET CONNECTION(sysid) RESYNC |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Display more definition and statistical |
| | information about the selected entry. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh the display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CREMOTE command security


CRESUSE

CRESUSE Command

The CRESUSE command displays statistical usage information for


defined and in use CICS resource definitions.

The following resources are included:

* Files
* Programs
* Transactions

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CRESUSE | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+

Transactions:
+------------------+--------------------------------------------------+
| Trans | The number of defined transactions. |
+------------------+--------------------------------------------------+
| TranUsed | The number of transaction that have been used. |
+------------------+--------------------------------------------------+
| TranEna | The number of transaction that are ENABLED. |
+------------------+--------------------------------------------------+
| TranDis | The number of transaction that are DISABLED. |
+------------------+--------------------------------------------------+

Programs:
+------------------+--------------------------------------------------+
| Programs | The number of defined programs. |
+------------------+--------------------------------------------------+
| ProgAct | The number of programs that are currently |
| | active or in use. |
+------------------+--------------------------------------------------+
| ProgUsed | The number of programs that have been used. |
+------------------+--------------------------------------------------+
| ProgEna | The number of programs that are ENABLED. |
+------------------+--------------------------------------------------+
| ProgDis | The number of programs that are DISABLED. |
+------------------+--------------------------------------------------+

Files:
+------------------+--------------------------------------------------+
| Files | The number of defined files. |
+------------------+--------------------------------------------------+
| FileOpen | The number of files with an OPEN status. |
+------------------+--------------------------------------------------+
| FileClos | The number of files with a CLOSED status. |
+------------------+--------------------------------------------------+
| FileEna | The number of files that are ENABLED. |
+------------------+--------------------------------------------------+
| FileDis | The number of files that are DISABLED. |
+------------------+--------------------------------------------------+
| FileRem | The number of files that are remote. |
| | Remote files are not included in enabled and |
| | disabled counts. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CREVIEW

CREVIEW Command

The CREVIEW command displays transaction usage and data collection


overhead summarized by interval. Statistics are updated at the
end of each minute interval.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CREVIEW | [ INTerval minutes ] |
| | |
| | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| INTERVAL | Specify the summarization interval for data |
| | rows. |
| | |
| | The interval data is available in 1 minute |
| | increments for the past 24 hours. |
| | |
| | Valid values are: |
| | 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, 60 |
| | |
| | Default interval: 60 |
| | |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+
| Transactions | The total number of transactions. |
| | The count includes those transactions that |
| | were excluded from statistical averaging due |
| | to excessive life time values. |
+------------------+--------------------------------------------------+
| Lifetime Average | The average lifetime of all transactions. |
+------------------+--------------------------------------------------+
| Interval | The requested summarization for data rows. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Hour,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Date | The date associated with collection interval. |
+------------------+--------------------------------------------------+
| Interval | The transaction interval. |
+------------------+--------------------------------------------------+
| Trans | The number of transactions executed. |
| | The count includes those transactions that |
| | were excluded from statistical averaging due |
| | to excessive life time values. |
+------------------+--------------------------------------------------+
| Pct% | The percentage of total transactions executed |
| | during that time period. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| These fields do not include those transactions that were excluded |
| from statistical averaging due to excessive life time values. |
+------------------+--------------------------------------------------+
| IOReqs | The total number of I/O requests. |
+------------------+--------------------------------------------------+
| Abends | The total number of abends. |
+------------------+--------------------------------------------------+
| Lifetime | Average lifetime |
+------------------+--------------------------------------------------+
| CPUTime | Average CPU time |
+------------------+--------------------------------------------------+
| DispTime | Average dispatch time |
+------------------+--------------------------------------------------+
| SuspTime | Average suspend time |
+------------------+--------------------------------------------------+
| EXWTime | Average exception wait time |
+------------------+--------------------------------------------------+
| DspDelay | Average dispatch delay time - 1st |
+------------------+--------------------------------------------------+
| FileTime | Average file wait time |
+------------------+--------------------------------------------------+
| MROTime | Average Inter-region wait time |
+------------------+--------------------------------------------------+
| MxtDelay | Average MXT delay 1st dispatch |
+------------------+--------------------------------------------------+
| RMITime | Average resource manager time |
+------------------+--------------------------------------------------+
| RMISusp | Average resource manager suspend |
+------------------+--------------------------------------------------+
| TermTime | Average terminal wait time |
+------------------+--------------------------------------------------+
| TCLDelay | Average tran class delay 1st dispatch |
+------------------+--------------------------------------------------+
| RMITotal | Average RMI time - Total |
+------------------+--------------------------------------------------+
| RMICPSM | Average RMI time - CPSM |
+------------------+--------------------------------------------------+
| RMIDBCTL | Average RMI time - DBCTL |
+------------------+--------------------------------------------------+
| RMIDB2 | Average RMI time - DB2 |
+------------------+--------------------------------------------------+
| RMIEXDLI | Average RMI time - EXEC DLI |
+------------------+--------------------------------------------------+
| RMIMQM | Average RMI time - MQ |
+------------------+--------------------------------------------------+
| RMIOTHER | Average RMI time - Other |
+------------------+--------------------------------------------------+
| RMITCPIP | Average RMI time - TCP/IP |
+------------------+--------------------------------------------------+
| WTRTime | Average wait to run time |
+------------------+--------------------------------------------------+
| GSVITime | Global user exit monitor time |
+------------------+--------------------------------------------------+
| GSVICPU | Global user exit CPU time |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| CICSCPU | The amount of CPU time that has been consumed |
| | by the CICS address space since the data |
| | collector was started. |
+------------------+--------------------------------------------------+
| ReqsGLUE | The total number of CICS Global User Exit |
| | requests that have been processed. |
| | For more information see: CGBLEXIT |
+------------------+--------------------------------------------------+
| CpuGLUE | The total CPU time that has been consumed |
| | by the data collector while processing the |
| | CICS Global User Exit requests. |
+------------------+--------------------------------------------------+
| GLUE% | The percentage of the CICS CPU time used |
| | by the GLUE data collection process. |
| | |
| | glue% = (CpuGLUE * 100) |
| | --------------- |
| | CICSCPU |
| | |
+------------------+--------------------------------------------------+
| ReqsMEI | The total number of Monitor Exit Interface |
| | requests that have been processed. |
+------------------+--------------------------------------------------+
| CpuMEI | The total CPU time that has been consumed |
| | by the data collector while processing the |
| | Monitor Exit Interface requests. |
+------------------+--------------------------------------------------+
| MEI% | The percentage of the CICS CPU time used |
| | by the Monitor Exit Interface process. |
| | |
| | glue% = (CpuMEI * 100) |
| | -------------- |
| | CICSCPU |
| | |
+------------------+--------------------------------------------------+
| ReqsCSF | The total number of Datacom CSF |
| | requests that have been processed. |
+------------------+--------------------------------------------------+
| CpuCSF | The total CPU time that has been consumed |
| | by the data collector while processing the |
| | Datacom CSF requests. |
+------------------+--------------------------------------------------+
| CSF% | The percentage of the CICS CPU time used |
| | by the Datacom CSF process. |
| | |
| | glue% = (CpuCSF * 100) |
| | -------------- |
| | CICSCPU |
| | |
+------------------+--------------------------------------------------+
| CpuSDCS | The total CPU time that has been consumed |
| | by the System data collector. |
| | For more information see: CSYSDMON |
+------------------+--------------------------------------------------+
| SDCS% | The percentage of the CICS CPU time used |
| | by the System data collection process. |
| | |
| | SDCS% = (CpuSDCS * 100) |
| | --------------- |
| | CICSCPU |
| | |
+------------------+--------------------------------------------------+
| ReqsXDIS | The total number of External Data Interface |
| | requests that have been processed. |
+------------------+--------------------------------------------------+
| CpuXDIS | The total CPU time that has been consumed |
| | by the External Data Interface task. |
+------------------+--------------------------------------------------+
| XDIS% | The percentage of the CICS CPU time used |
| | by the External Data Interface task. |
| | |
| | XDIS% = (CpuXDIS * 100) |
| | --------------- |
| | CICSCPU |
| | |
+------------------+--------------------------------------------------+
| CpuSCHT | The total CPU time that has been consumed |
| | by the scheduler. |
+------------------+--------------------------------------------------+
| SCHT% | The percentage of the CICS CPU time used |
| | by the scheduler process. |
| | |
| | SCHT% = (CpuSCHT * 100) |
| | --------------- |
| | CICSCPU |
| | |
+------------------+--------------------------------------------------+
| CpuTPPT | The total CPU time that has been consumed |
| | by the transaction post processor task. |
+------------------+--------------------------------------------------+
| TPPT% | The percentage of the CICS CPU time used |
| | by the transaction post processor task. |
| | |
| | TPPT% = (CpuTPPT * 100) |
| | --------------- |
| | CICSCPU |
| | |
+------------------+--------------------------------------------------+
| CpuLOGT | The total CPU time that has been consumed |
| | by the message logger task. |
+------------------+--------------------------------------------------+
| LOGT% | The percentage of the CICS CPU time used |
| | by the message logger task. |
| | |
| | LOGT% = (CpuLOGT * 100) |
| | --------------- |
| | CICSCPU |
| | |
+------------------+--------------------------------------------------+
| Now | Indicates that the current time is within |
| | this row. The "Interval" field is also |
| | highlighted. |
+------------------+--------------------------------------------------+
| Ago | The number of intervals prior to the current |
| | collection time period. |
+------------------+--------------------------------------------------+
| SDate | Start date of interval. |
+------------------+--------------------------------------------------+
| STime | Start time of interval. |
+------------------+--------------------------------------------------+
| Period | Elapsed time period of interval. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Redisplays the transaction information |
| | specifying an interval of 1 minute and |
| | positioning to the selected interval. |
+------------------+--------------------------------------------------+
| SYsd | Display system data collection interval |
| | records for the specified period. |
| | The CSYSDATA command will be invoked. |
+------------------+--------------------------------------------------+
| TLog | Display transaction detail records |
| | for the specified period. |
| | The CTRANLOG command will be invoked. |
+------------------+--------------------------------------------------+
| TSum | Display transaction summary records |
| | for the specified period. |
| | The CTRANSUM command will be invoked. |
+------------------+--------------------------------------------------+
| TXlog | Display transaction detail records |
| | for the specified period. |
| | The CTRANLOG command will be invoked specifying |
| | the CICS exception log as the log stream. |
+------------------+--------------------------------------------------+
| XLog | Display exception records for the specified |
| | period. |
| | The XLOG command will be invoked. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Related Information

SVWCOPTS Configuration Options


--------------------------------
TRANSACTION-ACTIVITY-PERSISTENT
CSCHEDUL

CSCHEDUL Command

The Event Scheduling facility is an event driver that is able to


perform a variety of functions at a specified time or a recurring
interval. This facility can be used to initiate functions within
SYSVIEW as well as outside the SYSVIEW boundaries.

Definitions can be added or maintained here (warm start) or


in parmlib member CICSSCHD (cold start).

Command Syntax

+------------------+--------------------------------------------------+
| CSCHEDUL | [ REGion | SYStem ] |
| | [ Local | Global ] |
| | [ GROUP group ] |
| | |
| | [ ADDLINE | NOADDLINE ] |
+------------------+--------------------------------------------------+

If SELECT is used with this command, the dummy input line for adding
new definitions always displays. The dummy add line is being excluded
from the select process.

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| Local | |
+------------------+--------------------------------------------------+
| SYStem | Display all CICS address spaces currently being |
| Global | monitored on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| ADDLINE | Display the "?Add" line. |
+------------------+--------------------------------------------------+
| NOADDLINE | Do not display the "?Add" line. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+
| Status | The current status of the Event Scheduling |
| | facility. |
| | |
| | Possible values are: |
| | |
| | ACTIVE The Event Scheduling facility is |
| | active and processing events. |
| | This can be true even if no |
| | events have been defined. |
| | SUSPENDED The Event Scheduling facility is |
| | active and event processing |
| | occurs, but no functions are |
| | performed. All functions are |
| | treated as a NOOP. |
| | INACTIVE The Event Scheduling facility has |
| | not been started. |
+------------------+--------------------------------------------------+
| Next event | The date and time that the next event executes. |
| | If no events are scheduled for the current day, |
| | then the next event is scheduled for midnight. |
+------------------+--------------------------------------------------+
| Interval | The time interval until the next event. |
+------------------+--------------------------------------------------+
| StartMode | Specifies the start mode at product |
| | initialization for the definitions. |
| | |
| | Possible values are: |
| | |
| | COLD - Definitions were obtained |
| | from parmlib members. |
| | |
| | WARM - Definitions were obtained |
| | from the persistent data store. |
| | If the data was not available in |
| | the persistent data store, the |
| | data will then be obtained from |
| | parmlib members. |
| | |
| | This value is initially set in parmlib member |
| | SVWCOPTS option SCHEDULER-STARTTYPE but can |
| | be overridden at SYSVIEW startup. |
+------------------+--------------------------------------------------+
| Checkpoint | Indicates whether a checkpoint is needed to save |
| | modified definitions. |
| | |
| | Possible values are: |
| | |
| | SAVED - No checkpoint is needed. |
| | |
| | REQUIRED - Definitions have been changed. |
| | These changes have not been |
| | saved. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Group | The group name to be associated with the |
| | event name. The group name is not part of the |
| | required unique event name key. |
+------------------+--------------------------------------------------+
| Name | The scheduled event name. The event name is |
| | highlighted if it is disabled. |
+------------------+--------------------------------------------------+
| Type | The scheduled event type. The type value is |
| | automatically corrected based on other |
| | parameters. |
| | Valid types are: |
| | |
| | SINGLE The event is to be performed once. |
| | This requires the "Every" |
| | parameter to be set to "NONE". |
| | |
| | RECUR The event is to be performed on |
| | a recurring interval for a |
| | specified number of occurrences. |
| | |
| | These recurring occurrences must |
| | all be within one day. |
| | |
| | MULTIDAY The event is to be performed on |
| | a recurring interval for a |
| | specified number of occurrences. |
| | |
| | These recurring occurrences occur |
| | across a day boundary. |
| | |
| | The first occurrence must start |
| | prior to midnight on day 1 and |
| | the last occurrence must end |
| | on day 2 prior to the original |
| | start time for day 1. |
| | |
+------------------+--------------------------------------------------+
| Every | The recurring interval time. If the event is |
| | type RECUR or MULTIDAY, then it has been defined |
| | to be a recurring event and must include a |
| | recurring interval. For example, perform event |
| | TEST0001 every 15 minutes. |
| | |
| | The recurring interval can be specified using |
| | the following formats: |
| | |
| | hh:mm:ss |
| | nnnnnnnS | nnnnSECs | nnSECOND |
| | nnnnMINs | nnMINUTE |
| | nnnnnnnH | nnnnHOUR |
| | nnnnnnnD | nnnnnDAY |
| | nnnnnnnW | nnnnWEEK |
| | |
| | The default value is NONE. |
| | |
| | The interval will be displayed using a |
| | HH:MM:SS format. |
| | |
| | The display format will switch to a |
| | n.nnDAYS format based on the profile |
| | option FMTHOURLIMIT setting. |
| | |
| | The profile option FMTPARTDAYS will always |
| | be processed as "DECIMAL". |
| | |
| | Minimum and maximum values by function: |
| | |
| | Function Minimum Maximum |
| | ---------------- -------- -------- |
| | NOOP none none |
| | OPERCMD none none |
| | CAPTURE none none |
| | IMOD none none |
| | LIST none none |
| | CICS-START-TRAN none none |
| | |
| | SYSDATA-RECORD 00:01:00 01:00:00 |
| | |
| | SYSTEM-CONDITION 00:01:00 01:00:00 |
| | SYSTEM-CONNECT 00:01:00 01:00:00 |
| | SYSTEM-FACILITY 00:01:00 01:00:00 |
| | SYSTEM-FILES 00:01:00 01:00:00 |
| | SYSTEM-IPCONN 00:01:00 01:00:00 |
| | SYSTEM-JVMSERVER 00:01:00 01:00:00 |
| | SYSTEM-PIPELINES 00:01:00 01:00:00 |
| | SYSTEM-PROGRAMS 00:01:00 01:00:00 |
| | SYSTEM-SOCKETS 00:01:00 01:00:00 |
| | SYSTEM-TCBPOOLS 00:01:00 01:00:00 |
| | SYSTEM-TCLASS 00:01:00 01:00:00 |
| | SYSTEM-TDATA 00:01:00 01:00:00 |
| | SYSTEM-TERMINALS 00:01:00 01:00:00 |
| | SYSTEM-TRANS 00:01:00 01:00:00 |
| | |
| | TRAN-REQUIRED 00:00:30 01:00:00 |
| | TRAN-SUMMARY 00:01:00 01:00:00 |
| | TRAN-THRESHOLDS 00:00:01 00:02:00 |
| | |
+------------------+--------------------------------------------------+
| Limit | The number of occurrences of the event that can |
| | be performed within the defined time period. |
| | |
| | Minimum value: 0 |
| | Maximum value: 99999999 |
| | Default value: 1 |
| | |
| | The following keyword can also be used to |
| | define the limit value: |
| | |
| | NONE 0 occurrences |
| | ONCE 1 occurrence |
| | FOREVER unlimited occurrences |
| | NOLIMIT unlimited occurrences |
| | |
| | Note: If the value for "Every" is set to NONE, |
| | then the limit value is forced to 1. |
+------------------+--------------------------------------------------+
| TimeBeg | The beginning time that the event is eligible to |
| | be performed. The time must be specified using |
| | the time format of the user as specified in the |
| | profile. "*" can also be coded to specify that |
| | no beginning time is to be associated with this |
| | event. If "*" is coded, then the event is |
| | eligible for execution anytime after midnight. |
| | By coding a start time, you can specify the |
| | first time that the event is eligible to |
| | execute. Also, if the event is a recurring |
| | type, then a specified time enforces |
| | synchronization based on the start time and |
| | interval specified. The time value can also be |
| | defined using any of the following values: |
| | |
| | 12AM | 1AM | 2AM | ... | 11AM |
| | 12PM | 1PM | 2PM | ... | 11PM |
| | NOON | MIDNIGHT |
| | |
| | The default value is "*". |
| | |
+------------------+--------------------------------------------------+
| TimeEnd | The end time that the event is eligible to be |
| | performed. The time must be specified using the |
| | time format of the user as specified in the |
| | profile. "*" can also be coded to specify that |
| | no end time is to be associated with this event. |
| | If "*" is coded, then the event is eligible for |
| | execution anytime before midnight. The time |
| | value can also be defined using any of the |
| | following values: |
| | |
| | 12AM | 1AM | 2AM | ... | 11AM |
| | 12PM | 1PM | 2PM | ... | 11PM |
| | NOON | MIDNIGHT |
| | |
| | The default value is "*". |
+------------------+--------------------------------------------------+
| Interval | The time interval until the next execution. |
| | This field is blank if the next execution time |
| | is not within the current day. |
| | |
| | If the event is currently disabled, the value |
| | displayed is the interval until the time when |
| | the next execution would occur if enabled. |
+------------------+--------------------------------------------------+
| NextTime | The time of the next execution. |
| | |
| | If the event is not scheduled to be executed, |
| | the field will be blank. |
| | |
| | Only the "time" of the next execution is |
| | displayed. The "date" of the next execution is |
| | not displayed. Based on the "Interval", the |
| | time of the next execution may not be "today". |
+------------------+--------------------------------------------------+
| LastTime | The last time the event was executed. |
+------------------+--------------------------------------------------+
| Count | The number of times that the event has been |
| | executed. |
+------------------+--------------------------------------------------+
| Function | The timer event function. This function |
| | controls the action that is taken when the |
| | event is executed. Each function can have |
| | optional parameters. |
| | Valid functions are: |
| | |
| | NOOP No action is to be performed. |
| | No parameters are required. |
| | If coded, then the parameters are |
| | ignored. |
| | |
| | LIST Perform the list of functions |
| | contained within the member |
| | specified. The specified member |
| | must reside in the parmlib data |
| | set. Functions that can be |
| | specified in the member are: |
| | |
| | NOOP |
| | OPERCMD 'parms' |
| | CAPTURE 'member parms' |
| | IMOD 'member parms' |
| | TRAN-START 'tran parms' |
| | |
| | OPERCMD Issue the specified MVS operator |
| | command. The specific operator |
| | command must be coded with the |
| | PARMS field. The parameters can |
| | contain symbolics. |
| | |
| | CAPTURE Asynchronously initiate an |
| | Event Capture request. This |
| | function captures command output |
| | for later redisplay. The |
| | specific capture event name or |
| | member name must be specified with |
| | the PARMS field. |
| | |
| | If "*" is coded, then the first |
| | 8 characters of the event name |
| | is used as the member name. |
| | |
| | If the event name contains the |
| | character "%", then it is |
| | translated to the character "P". |
| | |
| | If the resulting member name does |
| | not exist in the CAPLIB data set, |
| | a capture will not occur and a |
| | message will be generated |
| | indicating the member was not |
| | found. |
| | |
| | The parameters can contain |
| | symbolics. |
| | |
| | parms = member parameters |
| | * parameters |
| | |
| | IMOD Asynchronously execute an IMOD. |
| | The specific IMOD name or member |
| | name must be specified with the |
| | PARMS field. |
| | If "*" is coded, then the first |
| | 8 characters of the event name |
| | is used to build the IMOD name |
| | (CAP_event). |
| | |
| | The parameters can contain |
| | symbolics. |
| | |
| | parms = imodname parameters |
| | * parameters |
| | |
| | CICS-START-TRAN - Asynchronously start a |
| | CICS transaction. |
| | |
| | parms = tran parameters |
| | |
| | |
| | CICS data collection functions: |
| | |
| | SYSDATA-RECORD - System data collection |
| | interval records |
| | |
| | SYSTEM-CONDITION - CICS system status |
| | condition |
| | |
| | SYSTEM-CONNECT - CICS remote system |
| | connections |
| | |
| | SYSTEM-FACILITY - CICS connection facilities |
| | |
| | SYSTEM-FILES - CICS files |
| | |
| | SYSTEM-IPCONN - CICS IP connections |
| | |
| | SYSTEM-JVMSERVER - CICS JVM servers |
| | |
| | SYSTEM-PIPELINES - CICS pipelines |
| | |
| | SYSTEM-PROGRAMS - CICS programs |
| | |
| | SYSTEM-SOCKETS - CICS sockets |
| | |
| | SYSTEM-TCBPOOLS - CICS TCB pools |
| | |
| | SYSTEM-TCLASS - CICS transaction classes |
| | |
| | SYSTEM-TDATA - CICS transient data queues |
| | |
| | SYSTEM-TERMINALS - CICS terminals |
| | |
| | SYSTEM-TRANS - CICS transaction status |
| | |
| | TRAN-REQUIRED - CICS required transactions |
| | |
| | TRAN-SUMMARY - CICS transaction summary |
| | interval records |
| | |
| | TRAN-THRESHOLDS - CICS dynamic transaction |
| | threshold and cancellation.|
| | |
| | No parameters are supported. |
| | If coded, then the parameters are ignored. |
| | |
+------------------+--------------------------------------------------+
| Parms | Specific parameters associated with the |
| | function. |
+------------------+--------------------------------------------------+
| DateBeg | The beginning date of the first occurrence of |
| | this event. |
| | |
| | The date must be specified in the date format |
| | specified in the user's profile. |
| | |
| | Specify "*" when there is no begin date |
| | associated with this event. |
| | |
| | The default is value is "*". |
+------------------+--------------------------------------------------+
| DateEnd | The end date of the last occurrence of this |
| | event. |
| | |
| | The date must be specified in the date format |
| | specified in the user's profile. |
| | |
| | Specify "*" when there is no end date |
| | associated with this event. |
| | |
| | The default value is "*". |
+------------------+--------------------------------------------------+
| Sun | Specifies that the event is eligible to execute |
| Mon | on the specified day. To make a day eligible, |
| Tue | type the 3-character name in the appropriate |
| Wed | field or YES. To make the day ineligible, type |
| Thu | NO in the appropriate field. |
| Fri | |
| Sat | |
+------------------+--------------------------------------------------+
| SMTWTFS | The days of eligibility. |
| | |
| | S - Sunday |
| | M - Monday |
| | T - Tuesday |
| | W - Wednesday |
| | T - Thursday |
| | F - Friday |
| | S - Saturday |
+------------------+--------------------------------------------------+
| Description | The scheduled event description. |
+------------------+--------------------------------------------------+
| Status | The current status of the event. |
| | Valid values are: |
| | |
| | Enabled The event is enabled for |
| | processing |
| | |
| | Disabled The event schedule is disabled. |
| | |
| | A disabled event can be |
| | executed manually via the |
| | "RUN" line command. |
| | |
| | A disabled event can be modified. |
+------------------+--------------------------------------------------+
| Run | The number of times that the event has been |
| | executed via a RUN line command request. |
+------------------+--------------------------------------------------+
| RunDate | The date and time the event was executed via |
| RunTime | a RUN line command request. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Add | Add a new event definition. This command must |
| | be used on the dummy input line. |
+------------------+--------------------------------------------------+
| Copy | Copy definition attributes and create a new |
| | definition. |
+------------------+--------------------------------------------------+
| DELete | Delete the event definition. |
+------------------+--------------------------------------------------+
| DISable | Disable the definition. |
+------------------+--------------------------------------------------+
| Edit | Edit definition. |
+------------------+--------------------------------------------------+
| EList | Issue the EDIT command for the selected event. |
| | Only valid if Function = "LIST". |
+------------------+--------------------------------------------------+
| ENAble | Enable the definition. |
+------------------+--------------------------------------------------+
| RUN | Schedule the event for immediate execution. |
| | The "RUN" line command can be used to execute |
| | a disabled event. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Browse | Issue the BROWSE command for the selected event. |
| | Only valid if Function = "LIST". |
+------------------+--------------------------------------------------+
| Metrics | Invoke the VARS command selecting those |
| | metrics that are collected by the selected |
| | event scheduler function. |
| | |
| | Not all metrics are associated with an event |
| | scheduler function and not all event scheduler |
| | functions perform data collection. |
+------------------+--------------------------------------------------+
| VList | Issue the VIEW command for the selected event. |
| | Only valid if Function = "LIST". |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| ADD | Add new definition |
+------------------+--------------------------------------------------+
| LOAD | Load definitions. |
| | |
| | Syntax: LOAD [member] |
| | |
| | * - Load definitions from the |
| | blank persistent data store. If the |
| | WARM object is not found in the |
| | persistent data store, load |
| | the definitions from parmlib. |
| | |
| | The default parmlib member to be |
| | used is CICSSCHD. |
| | |
| | DATALIB - Load definitions from the |
| | persistent data store. |
| | |
| | COLD - Load definitions from parmlib. |
| | |
| | member - Load definitions from the |
| | specified parmlib member. |
| | |
| | The LOAD function does not delete or empty |
| | the current set of definitions prior to |
| | attempting the load. |
+------------------+--------------------------------------------------+
| RESUME | Resume timer event processing. |
+------------------+--------------------------------------------------+
| SAVE | Save definitions to the persistent data store. |
+------------------+--------------------------------------------------+
| SUSPEND | Suspend timer event processing. |
+------------------+--------------------------------------------------+

Related Information

Data collection controlled by the SYSVIEW scheduler

Security Requirements

For security requirements, use the link: CSCHEDUL command security


CSFBUSY

CSFBUSY Command

The CSFBUSY command displays the activity and busy percent


time for each CSF TCB.

Command Syntax

+------------------+--------------------------------------------------+
| CSFBUSY | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| CSF | Datacom/CICS Services release. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Index | The Multi-User Facility index value. |
+------------------+--------------------------------------------------+
| MUFname | The name of the Multi-User Facility. |
| | If the connection to the MUF is not active, |
| | the DBSIDxx module name will be displayed. |
+------------------+--------------------------------------------------+
| TCB# | The CSF TCB number. |
+------------------+--------------------------------------------------+
| Alloc | The number of times that the TCB has been |
| | allocated. |
+------------------+--------------------------------------------------+
| Reqs | The number of CSF requests. |
+------------------+--------------------------------------------------+
| Used | The distribution of work percentage for the |
| | TCBs. |
+------------------+--------------------------------------------------+
| Busy | The percentage of time that the TCB has been |
| | allocated. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSFCODES

CSFCODES Command

The CSFCODES command displays the return codes that have been
returned by Datacom Option for CICS Services.

Each request made to Datacom Option for CICS Services is


tallied by return code. When a request is successfully serviced,
the return code is blanks. Blank return codes are tallied as
00. A display showing the result of all requests issued since
CICS startup (or since the last time the statistics were reset).
This display enables you to monitor the frequency with which
error conditions prevent successful servicing of requests and
to determine the source of the errors.

Command Syntax

+------------------+--------------------------------------------------+
| CSFCODES | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| CSF | Datacom/CICS Services release. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Index | The Multi-User Facility index value. |
+------------------+--------------------------------------------------+
| MUFname | The name of the Multi-User Facility. |
| | If the connection to the MUF is not active, |
| | the DBSIDxx module name will be displayed. |
+------------------+--------------------------------------------------+
| RC | Return codes displayed in a matrix from 00 - 99. |
+------------------+--------------------------------------------------+
| x0 ... x9 | Specifies the number of times a specific return |
| | code has been returned. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSFIO

CSFIO Command

The CSFIO command displays start I/O statistics for each


CSF TCB.

Command Syntax

+------------------+--------------------------------------------------+
| CSFIO | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| CSF | Datacom/CICS Services release. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Index | The Multi-User Facility index value. |
+------------------+--------------------------------------------------+
| MUFname | The name of the Multi-User Facility. |
| | If the connection to the MUF is not active, |
| | the DBSIDxx module name will be displayed. |
+------------------+--------------------------------------------------+
| TCB# | The CSF TCB number. |
+------------------+--------------------------------------------------+
| Reqs | The number of CSF requests. |
+------------------+--------------------------------------------------+
| Reqs-Avg | The average request time, in seconds, since |
| | startup. |
+------------------+--------------------------------------------------+
| Reqs-Max | The maximum request time, in seconds, since |
| | startup. |
+------------------+--------------------------------------------------+
| Reqs-Tot | The total request time, in seconds, since |
| | startup. |
+------------------+--------------------------------------------------+
| SIOs | The total number of start I/Os. |
+------------------+--------------------------------------------------+
| SIOs-Avg | The average number of I/Os per request. |
+------------------+--------------------------------------------------+
| SIOs-Max | The maximum number of I/Os in one request. |
+------------------+--------------------------------------------------+
| SIOs-Zero | The number of requests that performed no I/O. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSFLOAD

CSFLOAD Command

The CSFLOAD command displays a list of currently loaded modules.

Command Syntax

+------------------+--------------------------------------------------+
| CSFLOAD | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| CSF | Datacom/CICS Services release. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Module | The module name. |
+------------------+--------------------------------------------------+
| Address | The address of the module. |
+------------------+--------------------------------------------------+
| SIDname | The associated SID name. |
+------------------+--------------------------------------------------+
| Vector | The address of module's vector table. |
+------------------+--------------------------------------------------+
| ModLP | The load point of the module. |
+------------------+--------------------------------------------------+
| DBLISTDS | The address of the DBLISTDS control block. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.
Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSFMUFS

CSFMUFS Command

The CSFMUFS command displays a list of Multi-User Facilities that


have been defined for use.

Command Syntax

+------------------+--------------------------------------------------+
| CSFMUFS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| CSF | Datacom/CICS Services release. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Index | The Multi-User Facility index value. |
+------------------+--------------------------------------------------+
| MUFname | The name of the Multi-User Facility. |
+------------------+--------------------------------------------------+
| SIDname | The DBSIDxx module name. |
+------------------+--------------------------------------------------+
| ConnStatus | The connection status. |
| | Possible values are: |
| | CONNECTED - Connected |
| | CONNECTING - Connection in progress |
| | DISCONNIMMED - Disconnect immediate in |
| | progress |
| | DISCONNECTING - Disconnect in progress |
| | DISCONNECTED - Disconnected |
| | UNCONNECTED - Unconnected |
| | RECONNECTABLE - Re-connectable |
| | UNKNOWN - Unknown status |
+------------------+--------------------------------------------------+
| MUFJobn | The MUF jobname. |
+------------------+--------------------------------------------------+
| TrueName | The CICS Task Related User Exit name. |
+------------------+--------------------------------------------------+
| Level | The release level. |
+------------------+--------------------------------------------------+
| SP | The Service Pack level. |
+------------------+--------------------------------------------------+
| SVC | The Datacom SVC number. |
+------------------+--------------------------------------------------+
| SubID | The Datacom SubID. |
+------------------+--------------------------------------------------+
| Connect | The connect type. |
| | Possible values are: |
| | PLT - PLT connection |
| | AUTO - Auto connection |
| | DEFERED - Defered connection |
+------------------+--------------------------------------------------+
| Conditions | The Open/Close conditions or return code |
| | status. |
+------------------+--------------------------------------------------+
| ATCBs | The number of allocated TCBs. |
+------------------+--------------------------------------------------+
| DTCBs | The number of desired TCBs. |
+------------------+--------------------------------------------------+
| Files | The number of file tables open. |
+------------------+--------------------------------------------------+
| DBCall | The number of calls using DBNTRY. |
+------------------+--------------------------------------------------+
| DBSIOs | The number of start I/Os for DBNTRY requests. |
+------------------+--------------------------------------------------+
| DCCall | The number of calls using Datacom. |
+------------------+--------------------------------------------------+
| DCSIOs | The number of start I/Os for Datacom requests. |
+------------------+--------------------------------------------------+
| OpCls | The number of OPEN and CLOSE requests. |
+------------------+--------------------------------------------------+
| Waits | The number of waits. |
+------------------+--------------------------------------------------+
| WNoIO | The number of waits without I/O. |
+------------------+--------------------------------------------------+
| RHeld | The number of requests held. |
+------------------+--------------------------------------------------+
| THeld | The total number of requests held. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSFOPTS

CSFOPTS Command

The CSFOPTS command displays the generation options of the


Datacom Option for CICS Services trace facility.

For detailed information about each option, see the Datacom


Option for CICS Services System Guide.

Command Syntax

+------------------+--------------------------------------------------+
| CSFOPTS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| CSF | Datacom/CICS Services release. |
+------------------+--------------------------------------------------+
| DBCVTPR | The address of the DBCVTPR module. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Option | The option description. |
+------------------+--------------------------------------------------+
| Parameter | The parameter name used in the DBCVTPR macro, |
| | if any. |
+------------------+--------------------------------------------------+
| Value | The value of the option. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSFREQS

CSFREQS Command

The CSFREQS command displays request information for DBIDs,


tables, and commands.

Command Syntax

+------------------+--------------------------------------------------+
| CSFREQS | [ Dbid | Table | Command | All ] |
| | [ MUFname name ] --- |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| Dbid | Display only the information summarized at the |
| | DBID level. |
+------------------+--------------------------------------------------+
| Table | Display only the information summarized at the |
| | DBID and table level. |
+------------------+--------------------------------------------------+
| Command | Display only the information summarized at the |
| | DBID, table, and command level. |
+------------------+--------------------------------------------------+
| All | Display all information levels. |
+------------------+--------------------------------------------------+
| MUFname | Display information for the specified MUF name. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| CSF | Datacom/CICS Services release. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Index | The Multi-User Facility index value. |
+------------------+--------------------------------------------------+
| MUFname | The name of the Multi-User Facility. |
| | If the connection to the MUF is not active, |
| | the DBSIDxx module name will be displayed. |
+------------------+--------------------------------------------------+
| DBID | The database ID. |
+------------------+--------------------------------------------------+
| Table | The table name. |
| | |
| | * - indicates all tables |
+------------------+--------------------------------------------------+
| Command | The command name. |
| | |
| | * - indicates all commands |
+------------------+--------------------------------------------------+
| Reqs | The number of CSF requests. |
+------------------+--------------------------------------------------+
| Average | The average request time in seconds. |
+------------------+--------------------------------------------------+
| Maximum | The maximum request time in seconds. |
+------------------+--------------------------------------------------+
| Total | The total request time in seconds. |
+------------------+--------------------------------------------------+
| AvgIO | The average number of I/Os per request. |
+------------------+--------------------------------------------------+
| MaxIO | The maximum number of I/Os in one request. |
+------------------+--------------------------------------------------+
| TotIO | The total I/Os. |
+------------------+--------------------------------------------------+
| Zero | The number of requests that performed no I/O. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSFTABLE

CSFTABLE Command

The CSFTABLE command displays the status of each table


defined in the User Requirements Table.

Command Syntax

+------------------+--------------------------------------------------+
| CSFTABLE | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| CSF | Datacom/CICS Services release. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| URT | The User Requirements Table suffix. |
+------------------+--------------------------------------------------+
| Table | The Datacom/DB table defined in the |
| | corresponding URT. |
+------------------+--------------------------------------------------+
| DBID | The database ID. |
+------------------+--------------------------------------------------+
| Update | Specifies that this table permits update. If |
| | it is blanks, then update is not permitted. |
+------------------+--------------------------------------------------+
| Synonym | Specifies that SYNONYM=YES is specified in the |
| | DBURTBL macro for this URT. If it is blanks, |
| | then SYNONYM=YES was not specified. All |
| | requests for this table must include the DBID |
| | in the request area. |
+------------------+--------------------------------------------------+
| Bypass | Specifies that this table has been disabled |
| | either because BYPOPEN=YES was coded in its URT |
| | definition or a DBOC DISABLE=urt.tbl command has |
| | been processed. When URT is opened, the |
| | designated table is bypassed from opening. |
+------------------+--------------------------------------------------+
| AutoDXC | Specifies that AUTODXC=YES was coded in the |
| | corresponding URT. If it is blanks, then |
| | AUTODXC=NO was coded. Exclusive control for |
| | this table is not automatically dropped when a |
| | second command is issued from the same Request |
| | Area. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSFTASKS

CSFTASKS Command

The CSFTASKS command displays the current users of the CICS


Service Facility TCBs.

Command Syntax

+------------------+--------------------------------------------------+
| CSFTASKS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| CSF | Datacom/CICS Services release. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Index | The Multi-User Facility index value. |
+------------------+--------------------------------------------------+
| MUFname | The name of the Multi-User Facility. |
| | If the connection to the MUF is not active, |
| | the DBSIDxx module name will be displayed. |
+------------------+--------------------------------------------------+
| TCB# | The CSF TCB number. |
+------------------+--------------------------------------------------+
| TRAN | The transaction ID. |
+------------------+--------------------------------------------------+
| Task# | The CICS task number. |
+------------------+--------------------------------------------------+
| Program | The current program. |
+------------------+--------------------------------------------------+
| Term | The CICS terminal ID. |
+------------------+--------------------------------------------------+
| DBID | The current DBID in use. |
+------------------+--------------------------------------------------+
| Table | The current table in use. |
+------------------+--------------------------------------------------+
| Command | The current command. |
+------------------+--------------------------------------------------+
| Status | The TCB usage status. |
+------------------+--------------------------------------------------+
| AllocDate | The date and time when the TCB was last |
| AllocTime | allocated. |
+------------------+--------------------------------------------------+
| Req-Date | The date and time of the last request made on |
| Req-Time | the TCB. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

The following actions can be used to cancel a CICS task.


The actions are listed in order of relative cancellation
power. Cancelling a task can cause damage to the CICS region.
In some cases a deferred abend request must be scheduled.
The deferred abend code will be set to "GSVC".
Where possible, SYSVIEW uses the CICS CEKL process to cancel tasks.

Task cancellation is done at your own risk!

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| PURge | Purge the selected task. |
| | |
| | Method: |
| | |
| | CEKL SET TASK(number) PURGE |
| | |
+------------------+--------------------------------------------------+
| FORcepur | Force purge the selected task. |
| | |
| | Method: |
| | |
| | CEKL SET TASK(number) FORCEPURGE |
| | |
+------------------+--------------------------------------------------+
| Cancel | Cancel the selected task. |
| | |
| | Progressive methods: |
| | |
| | CEKL SET TASK(number) PURGE |
| | |
| | If task still exists then |
| | CEKL SET TASK(number) FORCEPURGE |
| | |
+------------------+--------------------------------------------------+
| Kill | Kill the selected task. |
| | |
| | Progressive methods: |
| | |
| | CEKL SET TASK(number) PURGE |
| | |
| | If task still exists then |
| | CEKL SET TASK(number) FORCEPURGE |
| | |
| | If task still exists then |
| | CEKL SET TASK(number) KILL |
| | |
+------------------+--------------------------------------------------+
| CKill | Kill the selected task. |
| CICSKill | |
| | Method: |
| | |
| | CEKL SET TASK(number) KILL |
| | |
| | A PURGE or FORCEPUR should be attempted prior |
| | to issuing a CKILL. |
| | |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CSFTASKS command security


CSFTCBS

CSFTCBS Command

The CSFTCBS command displays the current TCB usage statistics.

Command Syntax

+------------------+--------------------------------------------------+
| CSFTCBS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| CSF | Datacom/CICS Services release. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
+------------------+--------------------------------------------------+
| Index | The Multi-User Facility index value. |
+------------------+--------------------------------------------------+
| MUFname | The name of the Multi-User Facility. |
| | If the connection to the MUF is not active, |
| | the DBSIDxx module name will be displayed. |
+------------------+--------------------------------------------------+
| TCB# | The CSF TCB number. |
+------------------+--------------------------------------------------+
| Type | The TCB request type. Valid values are: |
| | |
| | ALLOC TCB allocation |
| | HELD TCB held |
| | REQUESTS TCB requests |
+------------------+--------------------------------------------------+
| Count | The number of requests for type. |
+------------------+--------------------------------------------------+
| Average | The average request time for type. |
+------------------+--------------------------------------------------+
| Maximum | The maximum request time for type. |
+------------------+--------------------------------------------------+
| Total | The total request time for type. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSFTCBW

CSFTCBW Command

The CSFTCBW command displays the current TCB wait statistics.

Command Syntax

+------------------+--------------------------------------------------+
| CSFTCBW | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| CSF | Datacom/CICS Services release. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Index | The Multi-User Facility index value. |
+------------------+--------------------------------------------------+
| MUFname | The name of the Multi-User Facility. |
+------------------+--------------------------------------------------+
| InUse | Number of CSF TCBs currently in use |
+------------------+--------------------------------------------------+
| HWM | The high water mark of TCBs in use. |
+------------------+--------------------------------------------------+
| Waiters | The current number of waiters. |
+------------------+--------------------------------------------------+
| WaitHWM | The high water mark of waiters since startup. |
+------------------+--------------------------------------------------+
| Waits | The total number of waits since startup. |
+------------------+--------------------------------------------------+
| Average | The average time spent waiting, in seconds, |
| | since startup. |
+------------------+--------------------------------------------------+
| Maximum | The maximum time spent waiting, in seconds, |
| | since startup. |
+------------------+--------------------------------------------------+
| Total | The total time spent waiting, in seconds, since |
| | startup. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSFTRACE

CSFTRACE Command

The CSFTRACE command displays the current data found in the


Datacom Option for CICS Services trace facility.

Command Syntax

+------------------+--------------------------------------------------+
| CSFTRACE | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| CSF | Datacom/CICS Services release. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Index | The Multi-User Facility index value. |
+------------------+--------------------------------------------------+
| MUFsid | The name of the Multi-User Facility SID. |
+------------------+--------------------------------------------------+
| Time | The time of the trace event. |
+------------------+--------------------------------------------------+
| Tran | The CICS transaction ID associated with the |
| | task. |
+------------------+--------------------------------------------------+
| Task# | The CICS task number. |
+------------------+--------------------------------------------------+
| Program | The name of the program that issued the command. |
+------------------+--------------------------------------------------+
| Term | The CICS terminal ID. |
+------------------+--------------------------------------------------+
| DBID | The database ID. |
+------------------+--------------------------------------------------+
| Command | The Datacom/DB command being |
| | issued. |
+------------------+--------------------------------------------------+
| File | The name of the table being accessed. |
+------------------+--------------------------------------------------+
| Key | The name of the key for the table listed. |
+------------------+--------------------------------------------------+
| Code | The Datacom/DB return code. |
+------------------+--------------------------------------------------+
| IRC | The Datacom/DB internal return |
| | code. |
+------------------+--------------------------------------------------+
| URT | The User Requirement Table being accessed. |
+------------------+--------------------------------------------------+
| Opr | The operator ID, if any. |
+------------------+--------------------------------------------------+
| Userid | The userid. |
+------------------+--------------------------------------------------+
| TCB | The Task Control Block sequence number. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSFURTS

CSFURTS Command

The CSFURTS command displays information about the User


Requirements Table.

Command Syntax

+------------------+--------------------------------------------------+
| CSFURTS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| CSF | Datacom/CICS Services release. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| URT | The User Requirements Table suffix. |
+------------------+--------------------------------------------------+
| Module | The URT module name. |
+------------------+--------------------------------------------------+
| Address | The address of the URT module. |
+------------------+--------------------------------------------------+
| Type | The URT table type. Valid values are: |
| | |
| | STD URT assembled for applications issuing |
| | Datacom/DB commands |
| | SQL URT assembled for applications issuing |
| | SQL statements |
| | DYN URT dynamically built by another |
| | product, such as Dataquery |
+------------------+--------------------------------------------------+
| Start | Determines when to open. Valid values are: |
| | |
| | blank This URT has not been specified for |
| | delayed opening. It is opened during |
| | startup when the PLT is processed. |
| | AUTO This URT is defined with the parameter |
| | so that it is opened when initially |
| | required by an application request. |
| | DEFER This URT is defined with the parameter |
| | so that its opening is deferred until |
| | opened through the DBOC OPEN= command |
+------------------+--------------------------------------------------+
| OpenStat | The current open status. Valid values are: |
| | |
| | UNOPEN Not yet opened through a DBOC OPEN= |
| | transaction or invoked by an |
| | application request |
| | CLOSED Closed by Datacom Option |
| | for CICS Services |
| | CLOSING Specified with an Datacom |
| | Option for CICS Services CLOSE |
| | command, but not yet closed pending |
| | completion of transactions having |
| | exclusive control |
| | OPEN Opened by Datacom Option |
| | for CICS Services |
+------------------+--------------------------------------------------+
| TXNUD | Specifies that TXNUNDO=YES is specified in the |
| | DBURSTR macro defining this URT. Transaction |
| | backout is enabled for all update transactions |
| | against all tables declared in the URT. |
+------------------+--------------------------------------------------+
| Pri | The priority level for requests processed using |
| | this URT, where nn is between 01 and 15; 01 is |
| | low and 07 is the default. |
+------------------+--------------------------------------------------+
| ECWait | An ECWAIT= value between 0001 and 7200 specifies |
| | exclusive control wait time, in seconds, as |
| | specified in the TIMEMIN= or TIMESEC= DBURSTR |
| | parameters. |
+------------------+--------------------------------------------------+
| Users | The number of active tasks using this URT. |
+------------------+--------------------------------------------------+
| Reserve | The number of tasks that have read a record for |
| | update using this URT. |
+------------------+--------------------------------------------------+
| Message | A failure message indicating a return code. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| CLOSE | Close the selected URT |
+------------------+--------------------------------------------------+
| DELETE | Delete the selected URT |
+------------------+--------------------------------------------------+
| OPEN | open the selected URT |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| SELECT | Invokes the CSFTABLE command for the selected |
| | table. |
+------------------+--------------------------------------------------+
| TABLE | Invokes the CSFTABLE command for the selected |
| | table. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSFUSERS

CSFUSERS Command

The CSFUSERS command allows you to assess the impact of the


value assigned to the USERS= parameter, which specifies the
maximum number of users whose requests can be concurrently
serviced. You specify a value for the USERS= parameter in
DBCVTPR.

Command Syntax

+------------------+--------------------------------------------------+
| CSFUSERS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| CSF | Datacom/CICS Services release. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
+------------------+--------------------------------------------------+
| Index | The Multi-User Facility index value. |
+------------------+--------------------------------------------------+
| MUFname | The name of the Multi-User Facility. |
| | If the connection to the MUF is not active, |
| | the DBSIDxx module name will be displayed. |
+------------------+--------------------------------------------------+
| Users | A sequence number for a user invoking reserving |
| | transactions or physically waiting on a read |
| | event. |
+------------------+--------------------------------------------------+
| Freq | The total number of requests at the time a |
| | request arrives for service. |
+------------------+--------------------------------------------------+
| Pct% | Specifies the percentage of time that concurrent |
| | requests are being issued by the number in the |
| | Users column. |
+------------------+--------------------------------------------------+
| Pct-of-Total | Users concurrently invoking reserving |
| | transactions or physically waiting on a read |
| | event. |
| | |
| | If the bar graph is highlighted, then this |
| | indicates the number of Task Control Blocks |
| | beyond those allocated that were needed. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSIHOLD

CSIHOLD Command

The CSIHOLD command displays hold data information found in


a SMP/E CSI data set.

The command can be used to:

* Display hold data associated with a SYSMOD.

* Display hold data associated with a function.

* Display error data.

Suggested Screen Size

This command is best viewed on a display with a screen size that is


greater than 80 columns.
Follow this link for more information: Dynamic screen sizes

The data contained in the display fields can be large.


The provided field formats have been ordered and sized to display the
information based on typical data. You are encouraged to create new
formats or alter the supplied field formats to meet your needs.

Command Syntax

+------------------+--------------------------------------------------+
| CSIHOLD | [ CSI * | dsn ] |
| | [ SYSMods * | sysmod ] |
| | |
| | [ HOLDdata | NOHOLDdata ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| CSI dsn | Specify the SMP/E CSI data set name to be |
| | analyzed. |
| | |
| | Valid values are: |
| | |
| | * - Use the data set name defined |
| | in the System Configuration Options |
| | member. |
| | |
| | dsn.CSI - SMP/E CSI data set name. |
| | The dsn must end with '.CSI' |
| | |
| | The default CSI data set name is specified |
| | in the SYSVIEW System Configuration Options |
| | member. |
| | |
+------------------+--------------------------------------------------+
| SYSMods sysmod | Specify the SYSMODs to be displayed. |
| | |
| | Valid values are: |
| | |
| | * - Display all SYSMODs. |
| | |
| | sysmod - Display only the specified SYSMOD. |
| | Generic specification is not |
| | supported. |
| | |
+------------------+--------------------------------------------------+
| HOLDdata | Display the associated "++HOLD" hold data |
| | information as additional data rows in the |
| | field "HoldData". |
| | |
| | The "HoldData" field is a dynamic field. |
| | It will only be displayed if the HOLDDATA |
| | option is specified. |
| | |
| | HOLDDATA is the default option. |
+------------------+--------------------------------------------------+
| NOHOLDdata | Do not display "++HOLD" hold data information |
| | as additional data rows. |
| | |
| | The "HoldData" field is a dynamic field. |
| | The "HoldData" field will not be displayed. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| CSI | The SMP/E CSI data set name to be analyzed. |
| | |
| | Info field name: CSI |
+------------------+--------------------------------------------------+
| SYSMODs | Indicates the SYSMODs to be displayed. |
| | |
| | Valid values are: |
| | |
| | * - Display all SYSMODs. |
| | |
| | sysmod - Display only the specified SYSMODs. |
| | Generic specification is not |
| | supported. |
| | |
| | Info field name: SYSMODS |
+------------------+--------------------------------------------------+
| HoldData | Indicates whether associated "++HOLD" hold |
| | data information is to be displayed. |
| | |
| | Valid values are: |
| | |
| | YES - Display "++HOLD" information. |
| | |
| | NO - Do not display "++HOLD" information. |
| | |
| | Info field name: HOLDDATA |
+------------------+--------------------------------------------------+
Data Fields

Default Sort Order: SYSMOD,A,Date,A,Type,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SYSMOD | The name of the held SYSMOD. |
+------------------+--------------------------------------------------+
| Type | The hold category type into which the SYSMOD |
| | has been put. |
| | |
| | Possible values are: |
| | |
| | ERROR |
| | FIXCAT |
| | SYSTEM |
| | USER |
| | |
+------------------+--------------------------------------------------+
| Class | The alternate reason to release an exception |
| | SYSMOD for processing. |
+------------------+--------------------------------------------------+
| Reason | Identify the reason why the SYSMOD had been |
| | put into exception SYSMOD status. |
+------------------+--------------------------------------------------+
| Resolver | The SYSMOD that resolved the exception |
| | condition, if known. |
+------------------+--------------------------------------------------+
| FixCats | The number of fix category value associated |
| | with the entry. |
+------------------+--------------------------------------------------+
| FMID | The FMID to which the hold SYSMOD is applicable. |
+------------------+--------------------------------------------------+
| Date | The date that the ++HOLD statement was |
| | generated. |
+------------------+--------------------------------------------------+
| HoldData | The "++HOLD" hold data. |
| | |
| | The first data row for each SYSMOD entry will |
| | show a separator or dividor line. |
+------------------+--------------------------------------------------+
| Base | The Common Vulnerability Scoring System (CVSS) |
| | base score. This field will only be populated |
| | for HOLDDATA of type ERROR and class SECINT. |
+------------------+--------------------------------------------------+
| Temp | The Common Vulnerability Scoring System (CVSS) |
| | temporal score. This field will only be |
| | populated for HOLDDATA of type ERROR and class |
| | SECINT. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands


Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the CSIQUERY command to display |
| | information for the selected entry. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

Product Configuration Information

The default data set names are specified in the SYSVIEW


System Configuration Options member.

System Configuration Dsn : sysview.CNM4SCFG


System Configuration Member: GSVXGSVX

Configuration option Value


Dsn-System-CSI sysview.CSI
CSIORDER

CSIORDER Command

The CSIORDER command displays receive order information found in


a SMP/E CSI data set.

The command can be used to:

* Display a list of receive orders that have been requested.

* Display the status of receive order requests.

* Display a list of PTFs contained in a receive order.

Suggested Screen Size

This command is best viewed on a display with a screen size that is


greater than 80 columns.
Follow this link for more information: Dynamic screen sizes

The data contained in the display fields can be large.


The provided field formats have been ordered and sized to display the
information based on typical data. You are encouraged to create new
formats or alter the supplied field formats to meet your needs.

Command Syntax

+------------------+--------------------------------------------------+
| CSIORDER | [ CSI * | dsn ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| CSI dsn | Specify the SMP/E CSI data set name to be |
| | analyzed. |
| | |
| | Valid values are: |
| | |
| | * - Use the data set name defined |
| | in the System Configuration Options |
| | member. |
| | |
| | dsn.CSI - SMP/E CSI data set name. |
| | The dsn must end with '.CSI' |
| | |
| | The default CSI data set name is specified |
| | in the SYSVIEW System Configuration Options |
| | member. |
| | |
+------------------+--------------------------------------------------+

Information Fields
+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| CSI | The SMP/E CSI data set name to be analyzed. |
| | |
| | Info field name: CSI |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: Order,D

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Order | The order entry name. |
+------------------+--------------------------------------------------+
| OrderID | The order identifier assigned by the server |
| | when the order was created. |
+------------------+--------------------------------------------------+
| Status | The current status of the order. |
| | |
| | Possible values are: |
| | |
| | DOWNLOADED |
| | ERROR |
| | PENDING |
| | |
+------------------+--------------------------------------------------+
| Content | The content selected for the order. |
| | |
| | Possible values are: |
| | |
| | ALL |
| | APARS |
| | CRITICAL |
| | HOLDDATA |
| | PTFS |
| | RSUyymm |
| | |
+------------------+--------------------------------------------------+
| Zones | The target zones used to define the scope of |
| | the software inventory associated with this |
| | order. |
| | |
| | If more than one zone was used, the value will |
| | show "*". Use "SELECT" line command to display |
| | the details. |
+------------------+--------------------------------------------------+
| APARs | The number of APARs for which resolving PTFs |
| | are to be in the order. |
| | |
| | Use "SELECT" line command to display the details.|
+------------------+--------------------------------------------------+
| PTFs | The number of PTF SYSMODs to be in the order. |
| | |
| | Use "SELECT" line command to display the details.|
+------------------+--------------------------------------------------+
| OrderDate | The date on which the order request was made to |
| | the server. |
+------------------+--------------------------------------------------+
| OrderTime | The time on which the order request was made to |
| | the server. |
+------------------+--------------------------------------------------+
| DownDate | The date at which the order was downloaded and |
| | stored in the SMPNTS directory. |
+------------------+--------------------------------------------------+
| DownTime | The time at which the order was downloaded and |
| | stored in the SMPNTS directory. |
+------------------+--------------------------------------------------+
| Userid | The userid associated with the address space |
| | where SMP/E was executing when the order entry |
| | was created. |
+------------------+--------------------------------------------------+
| PackageID | The order package id value used to create |
| | a package subdirectory within the SMPNTS |
| | directory to contain the order's package files. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the CSIQUERY command to display |
| | information for the selected order. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

Product Configuration Information

The default data set names are specified in the SYSVIEW


System Configuration Options member.

System Configuration Dsn : sysview.CNM4SCFG


System Configuration Member: GSVXGSVX

Configuration option Value


Dsn-System-CSI sysview.CSI
CSIPROD

CSIPROD Command

The CSIPROD command displays the product, feature and FMID information
found in a SMP/E CSI data set.

The command can be used to:

* Display a list of products in a CSI.

* Display features associated with a product.

* Display FMIDs associated with a product and feature.

* Determine if the product has reached an end of service date.

Suggested Screen Size

This command is best viewed on a display with a screen size that is


greater than 80 columns.
Follow this link for more information: Dynamic screen sizes

The data contained in the display fields can be large.


The provided field formats have been ordered and sized to display the
information based on typical data. You are encouraged to create new
formats or alter the supplied field formats to meet your needs.

Command Syntax

+------------------+--------------------------------------------------+
| CSIPROD | [ CSI * | dsn ] |
| | [ EOSWarn * | days ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| CSI dsn | Specify the SMP/E CSI data set name to be |
| | analyzed. |
| | |
| | Valid values are: |
| | |
| | * - Use the data set name defined |
| | in the System Configuration Options |
| | member. |
| | |
| | dsn.CSI - SMP/E CSI data set name. |
| | The dsn must end with '.CSI' |
| | |
| | The default CSI data set name is specified |
| | in the SYSVIEW System Configuration Options |
| | member. |
| | |
+------------------+--------------------------------------------------+
| EOSWarn days | Specify the number of days prior to a defined |
| | end of service date for which the product will |
| | show a WARNING status. |
| | |
| | Valid values are: |
| | |
| | * - Use the default number of days. |
| | Default: 365 |
| | |
| | days - Any valid number of days. |
| | Minimum: 1 |
| | Maximum: 99999 |
| | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| CSI | The SMP/E CSI data set name to be analyzed. |
| | |
| | Info field name: CSI |
+------------------+--------------------------------------------------+
| EOSWarn | The number of days prior to a defined end of |
| | service or end of life date for which the |
| | EOSDate value will show a WARNING status. |
| | status. |
| | |
| | Info field name: EOSWarn |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: Seq,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Vendor | The vendor name of the product. |
+------------------+--------------------------------------------------+
| ProdID | The product ID. |
+------------------+--------------------------------------------------+
| VRM | The product version in the format: vv.rr.mm |
+------------------+--------------------------------------------------+
| Description | The product description. |
+------------------+--------------------------------------------------+
| Received | The date that the product was received. |
+------------------+--------------------------------------------------+
| GAAnnounce | The product GA announcement date. |
+------------------+--------------------------------------------------+
| GADate | The product GA date. |
+------------------+--------------------------------------------------+
| EOSDate | The end of service date for the product. |
| | |
| | This field will be displayed with a PROBLEM |
| | status if the End-Of-Service date is in the |
| | past. |
| | |
| | This field will be displayed with a WARNING |
| | status if the number of days until EOS is |
| | greater than the EOSWarn value. |
| | |
+------------------+--------------------------------------------------+
| EOSDays | The number of days until product End-Of-Service. |
+------------------+--------------------------------------------------+
| EOLDate | The end of life date for the product. |
| | |
| | This field will be displayed with a PROBLEM |
| | status if the End-Of-Life date is in the |
| | past. |
| | |
| | This field will be displayed with a WARNING |
| | status if the number of days until EOL is |
| | greater than the EOSWarn value. |
| | |
+------------------+--------------------------------------------------+
| EOLDays | The number of days until product End-Of-Life. |
+------------------+--------------------------------------------------+
| Feature | The feature name. |
+------------------+--------------------------------------------------+
| FeatDesc | The feature description. |
+------------------+--------------------------------------------------+
| FeatRecv | The date that the feature was received. |
+------------------+--------------------------------------------------+
| FMID | The FMID included in the feature. |
+------------------+--------------------------------------------------+
| FuncDesc | The function description associated with the |
| | FMID. |
+------------------+--------------------------------------------------+
| ProdSeq | The product sequence number. |
+------------------+--------------------------------------------------+
| FeatSeq | The feature sequence number within a product. |
+------------------+--------------------------------------------------+
| FMIDSeq | The FMID sequence number within a product and |
| | feature. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the CSIQUERY command to display |
| | information for the selected product ID (ProdID).|
+------------------+--------------------------------------------------+
| Feature | Invokes the CSIQUERY command to display |
| | information for the selected feature (Feature). |
+------------------+--------------------------------------------------+
| Life | Invokes the PRODLIFE command to display |
| | life cycle information for the selected |
| | product ID (ProdID). |
+------------------+--------------------------------------------------+
| Ptfs | Invokes the PTFS command to perform PTF analysis |
| | for the selected FMID. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

Product Configuration Information

The default data set names are specified in the SYSVIEW


System Configuration Options member.

System Configuration Dsn : sysview.CNM4SCFG


System Configuration Member: GSVXGSVX

Configuration option Value


Dsn-System-CSI sysview.CSI

Related Information

This command can retrieve product lifecycle information for


mainframe products, which can help identify products that are
nearing their end of service date. To learn more about how to
configure the retrieval of product lifecycle information, see
Configuring Product Lifecycle Information.

Product lifecycle information retrieval is configured in the SVWXPRDL


xmllib member.
CSIQUERY

CSIQUERY Command

The CSIQUERY command displays data returned from an SMP/E GIMAPI QUERY
command request. The data is stored in a VSAM data set called the
CSI (Consolidated Software Inventory).

* Detailed information can be viewed from any SMP/E CSI data set.

* The query can retrieve data from one or more zones in the CSI.

* SYSVIEW APIs can be used to query CSI information.

Product Configuration Information

The default CSI data set name is specified in the SYSVIEW


System Configuration Options member.

System Configuration Dsn : sysview.CNM4SCFG


System Configuration Member: GSVXGSVX

Configuration option Value


System-CSI-Dsn sysview.CSI

Command Syntax

+------------------+--------------------------------------------------+
| CSIQUERY | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ CSI dsn ] |
| | [ ZONE zone ] |
| | [ ENTRY entry ] |
| | [ SUBEntry subentry ] |
| | [ FILTER filter ] |
+------------------+--------------------------------------------------+

Parameters

Additional information regarding the syntax of the GIMAPI query


parameters can be found in the following IBM documentation:

z/OS SMP/E Reference


SMP/E CSI application programming interface
QUERY command

Example CSIQUERY commands

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| CSI dsn | Specify the SMP/E CSI data set name. |
| | The dsn must end with '.CSI' |
| | |
| | A default CSI data set name can be specified |
| | in the SYSVIEW System Configuration Options |
| | member. |
| | |
| | Keyword: Dsn-System-CSI |
| | |
+------------------+--------------------------------------------------+
| ZONE string | A character string that specifies the zones |
| | from which data is to be retrieved. |
| | |
| | You may enter one or more specific zone names |
| | separated by commas or blanks, or any of these |
| | values: |
| | |
| | GLOBAL - Use the global zone |
| | |
| | ALLTZONES - Use all target zones |
| | |
| | ALLDZONES - Use all DLIB zones |
| | |
| | * - Use all zones defined in the |
| | GLOBAL zone index. |
| | |
| | If multiple zones are specified, the string |
| | must be enclosed in quotes. |
| | |
| | Examples: |
| | |
| | 'GLOBAL,ALLTZONES' |
| | 'ALLTZONES,ALLDZONES' |
| | 'ALLTZONES,MY1DLIB,MY2DLIB' |
| | 'ALLTZONES MY1DLIB,MY2DLIB' |
| | |
+------------------+--------------------------------------------------+
| ENTRY string | A character string that indicates the entry |
| | types from the specified zones to be searched. |
| | |
| | You can specify one or more entries, separated |
| | by commas or blanks, or you can specify an |
| | asterisk '*' to indicate that all entries |
| | are to be searched. |
| | |
| | Valid entry types by zone: |
| | |
| | Entry type Global DLIB Target |
| | ------------ ------ ----- ------ |
| | ASSEM Valid Valid |
| | dataelement Valid Valid |
| | DDDEF Valid Valid Valid |
| | DLIB Valid Valid |
| | DLIBZONE Valid |
| | ELEMENT Valid Valid |
| | FEATURE Valid |
| | FMIDSET Valid |
| | GLOBALZONE Valid |
| | HFSelement Valid Valid |
| | HOLDDATA Valid |
| | JAR Valid Valid |
| | LMOD Valid Valid |
| | MAC Valid Valid |
| | MOD Valid Valid |
| | OPTIONS Valid |
| | ORDER Valid |
| | PRODUCT Valid |
| | PROGRAM Valid Valid |
| | SRC Valid Valid |
| | SYSMOD Valid Valid Valid |
| | TARGETZONE Valid |
| | UTILITY Valid |
| | ZONESET Valid |
| | |
+------------------+--------------------------------------------------+
| SUBENTRY string | A character string used to indicate the |
| | subentries for which data is retrieved. |
| | |
| | Several subentries can be specified, separated |
| | by commas or blanks, or you can specify an |
| | asterisk '*' to indicate that all subentries |
| | are to be searched. |
| | |
+------------------+--------------------------------------------------+
| FILTER string | A character string that specifies the set |
| | of conditions with which to limit the set |
| | of entries being retrieved. |
| | |
| | A condition is in the form: |
| | subentry operator 'value' |
| | |
| | Examples: |
| | |
| | 'FMID = ''CNM4H00''' |
| | 'INSTALLDATE ]= ''07203''' |
| | 'SMODTYPE=''PTF''' |
| | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| CSI | The SMP/E CSI data set name used. |
+------------------+--------------------------------------------------+
| Zone | The specified ZONE parameters. |
+------------------+--------------------------------------------------+
| Entry | The specified ENTRY parameters. |
+------------------+--------------------------------------------------+
| SubEntry | The specified SUBENTRY parameters. |
+------------------+--------------------------------------------------+
| Filter | The specified FILTER parameters. |
+------------------+--------------------------------------------------+

Data Fields
Default Sort Order: XSSystem,A,Seq,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Entry | The entry type. |
+------------------+--------------------------------------------------+
| EntryName | The entry name. |
+------------------+--------------------------------------------------+
| Zone | The zone name for the entry. |
+------------------+--------------------------------------------------+
| SubEntry | The subentry type. |
+------------------+--------------------------------------------------+
| Ver | The VER= statement when associated with the |
| | subentry type 'VER'. |
+------------------+--------------------------------------------------+
| Item | The item list data entries. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

The following is a list of sample query commands:

* DDDEF data sets


CSIQUERY ENTRY DDDEF SUBENTRY DATASET

* FEATURE information
CSIQUERY ENTRY FEATURE

* HFS information
CSIQUERY ENTRY HFS

* HOLDDATA for all SYSMODs


CSIQUERY ENTRY HOLDDATA

* JAR information
CSIQUERY ENTRY JAR

* OPTIONS information
CSIQUERY ENTRY OPTIONS

* PRODUCT information
CSIQUERY ENTRY PRODUCT

* RMID for all elements


CSIQUERY ZONE ALLTZONES ENTRY ELEMENT SUBENTRY RMID

* SYSMOD descriptions
CSIQUERY ZONE ALLTZONES ENTRY SYSMOD SUBENTRY DESCRIPTION
CSIT

CSIT Command

The CSIT command displays a list of CICS System Initialization


Table options and values.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CSIT | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+
| Module | The System Initialization Table name. |
+------------------+--------------------------------------------------+
| Address | The address of the System Initialization Table. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Option,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Option | The option name. |
+------------------+--------------------------------------------------+
| Description | A description of the SIT option. |
+------------------+--------------------------------------------------+
| Value | The value assigned to the option. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands


Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSITINIT

CSITINIT Command

The CSITINIT command displays a list of CICS System Initialization


Table (SIT) init parms (INITPARM) that have been defined.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CSITINIT | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Program,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Program | Program name |
+------------------+--------------------------------------------------+
| InitParms | Initial parameters. |
| | These parameters are available to the defined |
| | program. The program can access these parms by |
| | issuing the following CICS call: |
| | |
| | EXEC CICS ASSIGN |
| | INITPARM(initparms) |
| | INITPARMLEN(initparmslen) |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands


Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSMBUFF

CSMBUFF Command

The CSMBUFF command displays the status of the Communications


Storage Manager global buffer pool.

Command Syntax

+------------------+--------------------------------------------------+
| CSMBUFF | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYSTEM | This forces cross system data collection to be |
| XSDATA | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYSTEM | This forces cross system data collection to be |
| NOXSDATA | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Location,A,Size,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Location | The storage location |
| | Possible values are: |
| | ECSA |
| | DATASPACE |
| | HVCOMM |
+------------------+--------------------------------------------------+
| Size | Pool size |
+------------------+--------------------------------------------------+
| Storage | Total storage for buffers |
| | (Size * Buffers) |
+------------------+--------------------------------------------------+
| Buffers | Number of buffers |
+------------------+--------------------------------------------------+
| InUse | Number of buffers in use |
+------------------+--------------------------------------------------+
| Free | Number of buffers available for use |
+------------------+--------------------------------------------------+
| Pct% | The percentage of buffers in use |
+------------------+--------------------------------------------------+
| PctGraph | The bar graph is a representation of the |
| | percentage of buffers in use |
| | |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

The VTAM start option, SNAMGMT, must be set to YES, so that the ISTMGCEH
subtask will be attached to open the Network Management Interface.

Security Requirements

Access to the following SAF resource is required:

Class Profile/Entity Name Access


-------- --------------------------- ------
SERVAUTH IST.NETMGMT.sysname.SNAMGMT READ

'sysname' represents the MVS system name

If the above resource is not defined, then Superuser authority


is required. Superuser authority is either a UID of 0 or
READ access to the BPX.SUPERUSER entity in the FACILITY class.

If the command is displaying cross system data, the SYSVIEW


Main Services Address Space must have access to these security
resources also. The message 'QUSSR GET_CSM_STATS failed' in
the field XSMsg could indicate that authority was not granted.

The SAFAUTH command displays access rights to these resources.


CSMOWNER

CSMOWNER Command

The CSMOWNER command displays Communications Storage Manager


storage use by owning jobname.

Command Syntax

+------------------+--------------------------------------------------+
| CSMOWNER | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYSTEM | This forces cross system data collection to be |
| XSDATA | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYSTEM | This forces cross system data collection to be |
| NOXSDATA | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname owning the storage |
+------------------+--------------------------------------------------+
| ASID | The ASID of the address space owning the |
| | storage. |
+------------------+--------------------------------------------------+
| TotECSA | Total ECSA storage used |
+------------------+--------------------------------------------------+
| 4KECSA | ECSA storage used from 4K buffers |
+------------------+--------------------------------------------------+
| 16KECSA | ECSA storage used from 16K buffers |
+------------------+--------------------------------------------------+
| 32KECSA | ECSA storage used from 32K buffers |
+------------------+--------------------------------------------------+
| 60KECSA | ECSA storage used from 60K buffers |
+------------------+--------------------------------------------------+
| 180KECSA | ECSA storage used from 180K buffers |
+------------------+--------------------------------------------------+
| TotDS | Total data space storage used |
+------------------+--------------------------------------------------+
| 4KDS | Data space storage used from 4K buffers |
+------------------+--------------------------------------------------+
| 16KDS | Data space storage used from 16K buffers |
+------------------+--------------------------------------------------+
| 32KDS | Data space storage used from 32K buffers |
+------------------+--------------------------------------------------+
| 60KDS | Data space storage used from 60K buffers |
+------------------+--------------------------------------------------+
| 180KDS | Data space storage used from 180K buffers |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

The VTAM start option, SNAMGMT, must be set to YES, so that the ISTMGCEH
subtask will be attached to open the Network Management Interface.

Security Requirements

Access to the following SAF resource is required:

Class Profile/Entity Name Access


-------- --------------------------- ------
SERVAUTH IST.NETMGMT.sysname.SNAMGMT READ

'sysname' represents the MVS system name

If the above resource is not defined, then Superuser authority


is required. Superuser authority is either a UID of 0 or
READ access to the BPX.SUPERUSER entity in the FACILITY class.

If the command is displaying cross system data, the SYSVIEW


Main Services Address Space must have access to these security
resources also. The message 'QUSSR GET_CSM_STATS failed' in
the field XSMsg could indicate that authority was not granted.

The SAFAUTH command displays access rights to these resources.


CSMSTAT

CSMSTAT Command

The CSMSTAT command displays the status of the Communications


Storage Manager.

Command Syntax

+------------------+--------------------------------------------------+
| CSMSTAT | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Monitor | Status of the CSM monitor |
| | Possible values are: |
| | ACTIVE |
| | DYNAMIC |
| | INACTIVE |
+------------------+--------------------------------------------------+
| Current | Current storage allocated |
+------------------+--------------------------------------------------+
| Limit | Installation defined maximum limit |
+------------------+--------------------------------------------------+
| HWM | High water mark since IPL |
+------------------+--------------------------------------------------+
| Status | Status of storage pool area |
| | Possible values are: |
| | NORMAL |
| | CONSTRAINED |
| | CSM storage usage is higher than 80% |
| | of defined limits and is approaching |
| | the constrained level (85% of defined |
| | limits) |
| | CRITICAL |
| | CSM storage usage is at 90% of defined |
| | limits or higher |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: Dataspace,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Dataspace | Data space name |
+------------------+--------------------------------------------------+
| Token | STOKEN for the data space |
+------------------+--------------------------------------------------+
| ALET | ALET value for the data space |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

The VTAM start option, SNAMGMT, must be set to YES, so that the ISTMGCEH
subtask will be attached to open the Network Management Interface.

Security Requirements

Access to the following SAF resource is required:

Class Profile/Entity Name Access


-------- --------------------------- ------
SERVAUTH IST.NETMGMT.sysname.SNAMGMT READ

'sysname' represents the MVS system name

If the above resource is not defined, then Superuser authority


is required. Superuser authority is either a UID of 0 or
READ access to the BPX.SUPERUSER entity in the FACILITY class.

If the command is displaying cross system data, the SYSVIEW


Main Services Address Space must have access to these security
resources also. The message 'QUSSR GET_CSM_STATS failed' in
the field XSMsg could indicate that authority was not granted.

The SAFAUTH command displays access rights to these resources.


CSOCKETS

CSOCKETS Command

The CSOCKETS command displays a list of TCP/IP services that


have been defined to CICS. There is one entry for each listening
socket handled by the CICS Socket Domain listener.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CSOCKETS | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Service,A,Port,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Service | The name of the TCP/IP service. |
+------------------+--------------------------------------------------+
| Port | The port number. |
+------------------+--------------------------------------------------+
| Status | The state of the service. |
| | Possible values are: |
| | OPEN |
| | OPENING |
| | CLOSING |
| | IMMCLOSING |
| | CLOSED |
| | IMMCLOSED |
| | NONE |
| | |
| | The status NONE is displayed if the SIT option |
| | for TCPIP is set to NO. |
+------------------+--------------------------------------------------+
| IPAddress | The IP address. |
+------------------+--------------------------------------------------+
| Tran | The transaction to be attached. |
+------------------+--------------------------------------------------+
| Backlog | The backlog value for listen. |
+------------------+--------------------------------------------------+
| TSQpre | The temporary storage queue prefix. |
+------------------+--------------------------------------------------+
| URM | The name of the URM for service. |
+------------------+--------------------------------------------------+
| Sockets | The current number of open sockets. |
+------------------+--------------------------------------------------+
| SSL | Secure Sockets Layer. |
| | Possible values are: |
| | SSL Secure sockets layer |
| | CLIAUTH Client authorization |
+------------------+--------------------------------------------------+
| Sends | The number of sends. |
+------------------+--------------------------------------------------+
| Receives | The number of receives. |
+------------------+--------------------------------------------------+
| Attaches | The number of service attaches. |
+------------------+--------------------------------------------------+
| Users | The current number of individual sessions to |
| | clients. |
+------------------+--------------------------------------------------+
| ConnHWM | The high water mark of connections. |
+------------------+--------------------------------------------------+
| Listened | BPX1LTN has been called. |
+------------------+--------------------------------------------------+
| Bound | BPX1BND has been called. |
+------------------+--------------------------------------------------+
| ConnFail | A connection has failed. |
+------------------+--------------------------------------------------+
| Hostname | The host name. |
+------------------+--------------------------------------------------+
| Certificate | The certificate value. |
+------------------+--------------------------------------------------+
| Identity | A unique number for identity. |
+------------------+--------------------------------------------------+
| TDB | The address of the TDB control block. |
+------------------+--------------------------------------------------+
| LTE | The address of the LTE control block. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Close | Issues a close request for the selected service. |
+------------------+--------------------------------------------------+
| IMM | Issues an immediate close for the selected |
| | service. |
+------------------+--------------------------------------------------+
| Open | Issues an open request for the selected service. |
+------------------+--------------------------------------------------+

Subcommands
+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CSOCKETS command security


CSRT

CSRT Command

The CSRT command displays a list of system and user abend codes
that have been defined to CICS through the System Recovery Table.
These abend codes are intercepted by the CICS recovery
program DFHSRP.

Command Syntax

+------------------+--------------------------------------------------+
| CSRT | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Module | System Recovery Table name. |
+------------------+--------------------------------------------------+
| Address | The address of the System Recovery Table. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Code | The System or User abend code. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands


+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Quickref | Invokes the QUICKREF command for the selected |
| Select | abend code. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSTATUS

CSTATUS Command

The CSTATUS command displays the current value and status of a


selected set of variable resources.

Metrics that are owned by the System and Transaction Summary


data collectors are automatically included in this display.
Specific metrics belonging to the Transaction data collector can
be added. The list of available Transaction metrics can be viewed
on the METRICS command.

Definitions can be added or maintained here (warm start) or


in parmlib member CICSSTAT (cold start).

Command Syntax

+------------------+--------------------------------------------------+
| CSTATUS | [ REGion | SYStem ] |
| | [ Local | Global ] |
| | |
| | [ GROUP name ] |
| | |
| | [ Normal | WARNING ] |
| | |
| | [ GRPSONLY ] |
| | |
| | [ SAVE ] |
| | [ ADD metric [ rscename rscequal ]] |
| | [ DELETE metric [ rscename rscequal ]] |
+------------------+--------------------------------------------------+

If SELECT is used with this command, the dummy input line for adding
new definitions always displays. The dummy add line is being excluded
from the select process.

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| Local | |
+------------------+--------------------------------------------------+
| SYStem | Display all CICS address spaces currently being |
| Global | monitored on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| Normal | Display entries with a status of "Normal" or |
| | greater. |
+------------------+--------------------------------------------------+
| Warning | Display entries with a status of "Warning" or |
| | greater. |
+------------------+--------------------------------------------------+
| GRPSONLY | Display only entries with logical groups |
| | in "RsceName". |
+------------------+--------------------------------------------------+
| SAVE | Save the definitions to the persistent data |
| | store. |
| | |
| | If mode = LOCAL, the definitions for the |
| | current CICS jobname will be saved. |
| | |
| | If mode = GLOBAL, the definitions for all CICS |
| | jobnames on the current system will be saved. |
+------------------+--------------------------------------------------+
| ADD | Add new collection definition. |
| | |
| | Only metrics that belong to group CICSTRAN can |
| | be addred. |
| | |
| | Parameters: |
| | metric - metric name |
| | rscename - resource name value |
| | rscequal - resource qualifier value |
+------------------+--------------------------------------------------+
| DELETE | Delete an existing collection definition. |
| | |
| | Only metrics with a DefType of TRAN can be |
| | deleted. |
| | |
| | Parameters: |
| | metric - metric name |
| | rscename - resource name value |
| | rscequal - resource qualifier value |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+
| StartMode | Specifies the start mode at product |
| | initialization for the definitions. |
| | |
| | Possible values are: |
| | |
| | COLD - Definitions were obtained |
| | from parmlib members. |
| | |
| | WARM - Definitions were obtained |
| | from the persistent data store. |
| | If the data was not available in |
| | the persistent data store, the |
| | data will then be obtained from |
| | parmlib members. |
| | |
| | This value is initially set in parmlib member |
| | SVWCOPTS option VSTATUS-STARTTYPE but can be |
| | overridden at SYSVIEW startup. |
+------------------+--------------------------------------------------+
| Checkpoint | Indicates whether a checkpoint is needed to save |
| | modified definitions. |
| | |
| | Possible values are: |
| | |
| | SAVED - No checkpoint is needed. |
| | |
| | REQUIRED - Definitions have been changed. |
| | These changes have not been |
| | saved. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: Jobname,A,DefType,A,Metric,A,


RsceName,A,RsceQual,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname of the owning resource. |
+------------------+--------------------------------------------------+
| Metric | The metric resource name. |
+------------------+--------------------------------------------------+
| RsceName | Resource name for the metric. This value |
| | can be specified as a generic or wildcard. |
| | |
| | If the metric is defined as a transaction |
| | metric, then RsceName is a four character |
| | transaction id. |
| | |
| | If the metric is defined as a system metric, |
| | then RsceName is resource specific. |
| | See the METRICS command. |
+------------------+--------------------------------------------------+
| RsceQual | Resource qualifier for the metric. This value |
| | can be specified as a generic or wildcard. |
| | |
| | If the metric is defined as a transaction |
| | metric, then RsceQual is resource specific |
| | such as filename, program, terminal, etc. |
| | See the METRICS command. |
+------------------+--------------------------------------------------+
| Value | The last value that was evaluated by threshold |
| | processing. If no associated threshold is |
| | available, then the value contains the last |
| | collected value for the metric. |
+------------------+--------------------------------------------------+
| Status | The current associated threshold status. |
+------------------+--------------------------------------------------+
| RuleType | The exception rule type. |
| | |
| | Possible values are: |
| | |
| | UPPER - Upper limit threshold |
| | LOWER - Lower limit threshold |
| | ABOVE - Above limit threshold |
| | BELOW - Below limit threshold |
| | CHANGE - Change in value threshold |
+------------------+--------------------------------------------------+
| DefType | The definition type. |
| | |
| | Possible values are: |
| | |
| | SYSTEM - System data collection |
| | TRANS - Transaction data collection |
| | TRANSUMM - Transaction summary data collection|
+------------------+--------------------------------------------------+
| Current | The current value is defined as the average |
| | resource value over the last "n" minutes. |
| | The number of minutes is defined by the |
| | duration value of an associated threshold |
| | definition. If no threshold definition is |
| | available, the interval is 2 minutes. |
+------------------+--------------------------------------------------+
| Average | The average value for the element over the last |
| | hour. |
+------------------+--------------------------------------------------+
| Median | The median value for the element over the last |
| | hour. |
+------------------+--------------------------------------------------+
| StdDev | The standard deviation for the element over the |
| | last hour. |
+------------------+--------------------------------------------------+
| Change | The difference between the duration average |
| | "Current" and the mean average "Average". |
+------------------+--------------------------------------------------+
| ChgStd | The "Change" value expressed as standard |
| | deviations. |
+------------------+--------------------------------------------------+
| Warning | The threshold limit value that the metric |
| | resource must reach to obtain the WARNING status.|
+------------------+--------------------------------------------------+
| Problem | The threshold limit value that the metric |
| | resource must reach to obtain the PROBLEM status.|
+------------------+--------------------------------------------------+
| Minimum | The minimum average value for the last interval. |
+------------------+--------------------------------------------------+
| Maximum | The maximum average value for the last interval. |
+------------------+--------------------------------------------------+
| MetAlias | The metric alias name. |
+------------------+--------------------------------------------------+
| Class | The data collection class associated with the |
| | metric. |
+------------------+--------------------------------------------------+
| Group | The data collection group associated with the |
| | metric. |
+------------------+--------------------------------------------------+
| SubGroup | The data collection subgroup associated with the |
| | metric. |
+------------------+--------------------------------------------------+
| Description | A description of the metric. |
+------------------+--------------------------------------------------+
| -0 | The metrics value for the last 10 intervals. |
| . | |
| -9 | |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Add | Add new definition. |
+------------------+--------------------------------------------------+
| DELete | Delete definition. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Graph | Invokes the GRAPH command for the selected |
| | metric resource. |
+------------------+--------------------------------------------------+
| Metric | Invokes the METRICS command for the selected |
| | metric name. |
+------------------+--------------------------------------------------+
| Plot | Invokes the PLOT command for the selected |
| | metric resource. |
+------------------+--------------------------------------------------+
| Select | Invokes the MOREINFO command for the selected |
| | entry. |
+------------------+--------------------------------------------------+
| Rule | Invokes the RULES command for the selected |
| | metric name. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| ADD | Add new collection definition. |
| | |
| | Only metrics that belong to group CICSTRAN can |
| | be added. |
| | |
| | Syntax: ADD metric [ rscename rscequal ] |
| | |
| | Parameters: |
| | metric - metric name |
| | rscename - resource name value |
| | rscequal - resource qualifier value |
+------------------+--------------------------------------------------+
| DELETE | Delete an existing collection definition. |
| | |
| | Only metrics that belong to group CICSTRAN can |
| | be deleted. |
| | |
| | Syntax: DELETE metric [ rscename rscequal ] |
| | |
| | Parameters: |
| | metric - metric name |
| | rscename - resource name value |
| | rscequal - resource qualifier value |
+------------------+--------------------------------------------------+
| SAVE | Save the definitions to the persistent data |
| | store. |
| | |
| | If mode = LOCAL, the definitions for the |
| | current CICS jobname will be saved. |
| | |
| | If mode = GLOBAL, the definitions for all CICS |
| | jobnames on the current system will be saved. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Related Information
CICS Metrics

Security Requirements

For security requirements, use the link: CSTATUS command security


CSUBPOOL

CSUBPOOL Command

The CSUBPOOL command displays a list of CICS subpools owned


by the CICS storage manager.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CSUBPOOL | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Subpool,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Subpool | The name of the CICS subpool |
+------------------+--------------------------------------------------+
| Num | The ID number of the subpool. |
+------------------+--------------------------------------------------+
| DSAname | The name of the Dynamic Storage Area that owns |
| | the subpool. |
+------------------+--------------------------------------------------+
| Access | The access type of the subpool. |
| | Possible values are: |
| | blank |
| | CICS |
| | USER |
| | READ |
| | TRUST |
| | SECURE |
+------------------+--------------------------------------------------+
| Elements | The number of elements in the subpool. |
+------------------+--------------------------------------------------+
| Used | The total number of bytes that are currently in |
| | use by the subpool. |
+------------------+--------------------------------------------------+
| Free | The total number of bytes that are currently |
| | available within the subpool. |
+------------------+--------------------------------------------------+
| Alloc | The total number of bytes that are allocated to |
| | the subpool. All allocated storage may not |
| | be in use due to fragmentation or GETMAIN |
| | alignment boundaries. |
+------------------+--------------------------------------------------+
| Pct% | The percentage of storage used in the owning |
| | DSA. |
+------------------+--------------------------------------------------+
| Type | Element type. |
| | Possible values are: |
| | Fix |
| | Variable |
+------------------+--------------------------------------------------+
| FixedLen | The length of each element in the subpool. |
| | Valid only for fixed type subpools. |
+------------------+--------------------------------------------------+
| Getmains | The number of GETMAIN requests for the subpool. |
+------------------+--------------------------------------------------+
| Freemain | The number of FREEMAIN requests for the subpool. |
+------------------+--------------------------------------------------+
| InitFree | The total storage allocated when the domain |
| | subpool is preallocated. |
+------------------+--------------------------------------------------+
| MaxFree | The largest free storage element. |
| | Valid only grande DSA subpools. |
+------------------+--------------------------------------------------+
| AllocHWM | The high water mark of storage allocated to the |
| | subpool. |
+------------------+--------------------------------------------------+
| Align | The GETMAIN alignment boundary for allocation. |
+------------------+--------------------------------------------------+
| Cell | The subpool uses the CELLPOOL allocation method. |
+------------------+--------------------------------------------------+
| Stgv | Storage violation checking is active for the |
| | subpool. |
+------------------+--------------------------------------------------+
| SCA | The address of the SCA control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Dsas | Invokes the CDSAS command selecting the current |
| | DSA of the subpool selected. |
+------------------+--------------------------------------------------+
| Elements | Invokes the CELEMENT command selecting the |
| | current subpool. |
+------------------+--------------------------------------------------+
| Xtents | Invokes the CDSAX command selecting the current |
| | DSA of the subpool selected. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSUBSPAC

CSUBSPAC Command

The CSUBSPAC command displays a list of subspaces that are


currently executing within the CICS address space.

Command Syntax

+------------------+--------------------------------------------------+
| CSUBSPAC | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Storage | The CICS storage isolation option. Valid values |
| isolation | are ACTIVE or INACTIVE. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Subspace | The subspace type. Valid values are COMMON or |
| | UNIQUE. |
+------------------+--------------------------------------------------+
| Current | The current number of subspaces. |
+------------------+--------------------------------------------------+
| High | The maximum number of concurrent subspaces. |
+------------------+--------------------------------------------------+
| Total | The total number of subspaces allocated since |
| | last CICS statistics reset. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Subspace | The subspace name defined by MVS. |
+------------------+--------------------------------------------------+
| QRALET | The access list entry token for the QR TCB. |
+------------------+--------------------------------------------------+
| OPENALET | The access list entry token for the OPEN TCB. |
+------------------+--------------------------------------------------+
| Stoken | The Stoken value assigned to the subspace. |
+------------------+--------------------------------------------------+
| Common | The common subspace. COMMON is displayed if the |
| | subspace is the CICS common subspace. |
+------------------+--------------------------------------------------+
| Tran | The transaction ID that owns the subspace. |
+------------------+--------------------------------------------------+
| Task# | The transaction task number that owns the |
| | subspace. |
+------------------+--------------------------------------------------+
| SUA | The address of the SUA control block. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invoke the CTASKS command for the selected |
| Tasks | subspace. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSYMBOLS

CSYMBOLS Command

The CSYMBOLS command displays a list of symbols and address


locations to CICS storage.

Command Syntax

+------------------+--------------------------------------------------+
| CSYMBOLS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Symbol | The symbol name. |
+------------------+--------------------------------------------------+
| Address | The address of storage. |
+------------------+--------------------------------------------------+
| Length | The decimal length of storage. |
+------------------+--------------------------------------------------+
| Mapname | The DSECT name used to map storage. |
| | Some symbols may not have a corresponding map |
| | or DSECT available. If no map is available, a |
| | value of "*" will be displayed. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands


Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DUMp | Invokes the DUMP command for the Address value. |
| Select | |
+------------------+--------------------------------------------------+
| Map | Invokes the MAP command for the Address value |
| | and the Mapname map. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CSYSDATA

CSYSDATA Command

The CSYSDATA command displays CICS system interval records.

A log can potentially contain a very large number of records. For


this reason, only the specified number of records will be displayed.
This set of records is referred to as the "display window", and is
controlled by the LINES parameter on the command or the LINES
parameter on the OPTIONS subcommand.

Command Syntax

+------------------+--------------------------------------------------+
| | |
| &HelpMember | [ STREAM logstream ] |
| | |
| | [ DATE * | date ] |
| | [ TIME * | time ] |
| | |
| | [ READNext ] |
| | [ READPrev ] |
| | |
| | [ PERiod hh:mm:ss ] |
| | [ CUSHion hh:mm:ss ] |
| | |
| | [ LINEs datalines ] |
| | [ LIMit readlimit ] |
| | [ ELAPsedlimit hh:mm:ss ] |
| | |
| | [ RECtime END | START ] |
| | |
| | [ DISCARD ] |
| | [ NODISCARD ] |
| | |
| | [ FILTER ] |
| | [ NOFILTER ] |
| | |
| | [ GROUP group ] |
| | [ JOBName jobname ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| STREAM logstream | Specifies the log stream name from which to |
| | display data. |
| | |
| | If no log stream name is specified, the parmlib |
| | member LGLOOKUP will be used to locate a |
| | matching log stream name. |
| | |
| | Use the following "short" names to substitute |
| | the default log stream name for the indicated |
| | record type: |
| | |
| | AUDIT - Audit events |
| | CICSEITL - CICS EXEC interface trace log |
| | CICSSYSD - CICS system interval analysis |
| | CICSTRAN - CICS transaction log |
| | CICSTSUM - CICS transaction summary log |
| | CICSXLOG - CICS exception log |
| | CTGLOG - CICS Transaction Gateway log |
| | IMSIMTR - IMS transaction log |
| | IMSIMRS - IMS region summary log |
| | IMSIMTS - IMS transaction summary log |
| | IMSOMAT - IMS OM audit trail log |
| | MQSDATA - MQ request history log |
| | OPERLOG - Operations log stream |
| | PLOTLOG - Historical plot log |
| | SMFDATA - SMF log |
| | XLOG - Exception log |
| | ZCNRLOG - z/OS Connect request log |
| | |
+------------------+--------------------------------------------------+
| DATE date | Position to specified date in log. |
| | Read records from the starting point in a |
| | forward direction ( youngest to newest ). |
| | |
| | date - The date value must be specified |
| | using the date format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | Query current date format |
| | |
| | * - Use the current date (today). |
| | |
| | -days - Position to today's date |
| | minus the specified number |
| | of days. |
| | |
| | If a DATE value is supplied and a TIME |
| | value is not supplied, the current TIME (now) |
| | will be used. |
| | |
+------------------+--------------------------------------------------+
| TIME time | Position to specified time in log. |
| | |
| | time - The time value must be specified |
| | using the time format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | Query current time format |
| | |
| | * - Use the current time (now). |
| | |
| | nnAM - The time value can also be |
| | nnPM specified using one of the |
| | following values: |
| | 12AM | 1AM | 2AM | ... | 11AM |
| | 12PM | 1PM | 2PM | ... | 11PM |
| | NOON | MIDNIGHT |
| | |
| | -adjust - Set the time value to the |
| | +adjust current time (now) plus or minus |
| | the specified adjustment value. |
| | |
| | Example adjustment values: |
| | |
| | -0.500000 - 0.5 seconds |
| | -60 - 60 seconds |
| | -120Sec - 120 seconds |
| | -5MINutes - 5 minutes |
| | -1Hours - 1 hour |
| | -1Days - 1 day |
| | -hh:mm:ss - hours:minutes:seconds |
| | |
| | +0.500000 + 0.5 seconds |
| | +60 + 60 seconds |
| | +120Sec + 120 seconds |
| | +5MINutes + 5 minutes |
| | +1Hours + 1 hour |
| | +1Days + 1 day |
| | +hh:mm:ss + hours:minutes:seconds |
| | |
| | If a TIME value is supplied and a DATE |
| | value is not supplied, the current DATE |
| | will be used. |
| | |
+------------------+--------------------------------------------------+
| READPrev | If a date or time value is specified, READPREV |
| | specifies that the log is to be read starting |
| | at the date and time and read backwards |
| | (youngest to oldest). |
| | |
| | If date or time is not specified, the READPREV |
| | parameter is ignored. |
| | |
+------------------+--------------------------------------------------+
| READNext | If a date or time value is specified, READNEXT |
| | specifies that the log is to be read starting |
| | at the date and time and read forwards |
| | (oldest to youngest). |
| | |
| | If date or time is not specified, the READNEXT |
| | parameter is ignored. |
| | |
+------------------+--------------------------------------------------+
| PERiod hh:mm:ss | Specifies the time period for which records are |
| | to be displayed. |
| | |
| | Default : 0 (unlimited) |
| | |
| | Example values: |
| | |
| | NONE - No period (unlimited) |
| | 0 - No period (unlimited) |
| | 0.500000 - 0.5 seconds |
| | 60 - 60 seconds |
| | 120Sec - 120 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | 1Days - 1 day |
| | 1MONths - 1 month |
| | 1Years - 1 year |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| CUSHion hh:mm:ss | Specifies the time period cushion for which |
| | records are to be read for display. |
| | |
| | Data records stored in an MVS log stream are |
| | sequenced or sorted based on the actual time |
| | the record was written to the stream. |
| | |
| | This does not guarantee that the records are |
| | sorted in a time sequence based on the |
| | date and time information that is potentially |
| | contained within each record. |
| | |
| | For this reason, when a user wants to display |
| | a specific time period of data, additional |
| | records must be read on the front and back |
| | end of the read process to ensure that the |
| | records that might be out of sequence are |
| | included. |
| | |
| | The time period cushion specifies the extra |
| | records to be read. |
| | |
| | Example Cushion: |
| | |
| | Start time: 8AM |
| | Period : 1 Hour |
| | Cushion : 5 minutes |
| | |
| | Read Begin : 07:55:00 |
| | -- Discard records |
| | Display Begin : 08:00:00 |
| | -- Display records |
| | Display End : 09:00:00 |
| | -- Discard records |
| | Read End : 09:05:00 |
| | |
| | Example values: |
| | |
| | NONE - No cushion |
| | 0 - No cushion |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| LINEs count | Specifies the maximum number of data rows to |
| | be displayed. |
| | |
| | Default : 25000 |
| | Minimum : 1 |
| | Maximum : 1000000 |
| | |
| | Specifying the LINES value with the primary |
| | command syntax does not alter or change the |
| | default value stored in the user profile. |
| | |
| | The default value can be altered using the |
| | subcommand: OPTIONS LINES count |
| | |
| | The actual number of data rows displayed may |
| | be greater than the specified LINES value if |
| | a record or message expanded to multiple lines. |
| | |
+------------------+--------------------------------------------------+
| LIMit count | Specifies the maximum number of records to be |
| | read. |
| | |
| | Specifying the LIMIT value with the primary |
| | command syntax does not alter or change the |
| | default value stored in the user profile. |
| | |
| | The default value can be altered using the |
| | subcommand: OPTIONS LIMIT count |
| | |
| | Default : 1000000 |
| | |
+------------------+--------------------------------------------------+
| ELAPsed hh:mm:ss | Specifies the elapsed time limit for reading |
| | or searching the log streams for desired |
| | data. |
| | |
| | If the log stream being searched is very large, |
| | the search time required can be substantial. |
| | This is especially true if a large number |
| | of data LINES has been requested and the |
| | number of data records that would satisfy |
| | the search request are spread across the |
| | entire log stream. |
| | |
| | The log browse search will be interrupted |
| | when the elapsed time limit is reached. |
| | |
| | The search can be continued using the |
| | subcommands: NEXT or PREVIOUS |
| | |
| | Example values: |
| | |
| | NONE - No timeout |
| | 0 - No timeout |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| RECORDTime | Specifies whether the "start" or "end" date |
| RECTime | and time should be used for the records. |
| | |
| | Not all records have a start and an end |
| | time. Records that do not have both a start |
| | and an end time are considered "events". |
| | |
| | Records that are interval based typically |
| | do have a start and end time. |
| | |
| | Records that are event based typically do not. |
| | |
| | Valid values: |
| | |
| | END |
| | START |
| | EVENT |
| | |
+------------------+--------------------------------------------------+
| DISCard | Specifies whether records found to be in the |
| NODISCard | time period cushion should be discarded or |
| | kept. |
| | |
| | DISCARD - Discard the records found in |
| | the cushion. (default) |
| | |
| | NODISCARD - Keep the records found in the |
| | cushion. |
| | |
+------------------+--------------------------------------------------+
| FILTER | Display a "filter" screen to allow the |
| NOFILTER | entering of command syntax parameters to |
| | filter the data. |
| | |
| | When the "FILTER" keyword is entered as part |
| | of the primary command, the parameters entered |
| | will be used to populate the filter display. |
| | |
| | After entering desired data on the filter |
| | display, the following function keys can |
| | be used: |
| | |
| | ENTER - Validate the data entered. |
| | No processing occurs. |
| | |
| | F1 - Invoke HELP for the filter display. |
| | |
| | F3 - Validate the data entered and |
| | process the data to build the |
| | display. |
| | |
| | F12 - Do not validate data. No processing |
| | occurs. The existing data is |
| | redisplayed. |
| | |
| | FILTER - Display filter. |
| | |
| | NOFILTER - Do not display filter (default). |
| | |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| GROUP | Specifies a logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames to be |
| | displayed. |
| | |
| | Syntax: GROUP group |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used as the |
| | default. |
| | |
| | The current profile setting can be viewed using |
| | the following: QUERY CICSGROUP |
| | |
| | The list of CICSPLEX groups can be found on |
| | GROUPS command. |
+------------------+--------------------------------------------------+
| JOBName | Specifies the jobname that is to be displayed. |
| | |
| | The jobname can be specified as: |
| | * Specific jobname |
| | * Generic jobname |
| | * Logical group name containing a list of |
| | of CICS jobnames. |
| | Logical group type = CICSPLEX |
| | Syntax: ]group |
| | |
| | Syntax: JOBNAME jobname |
+------------------+--------------------------------------------------+

Information Fields

The Information Section area is cursor selectable.


If the cursor is in the Information Section and the [ENTER] key
is pressed, the "FILTER" panel will be displayed.

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| LogStream | The name of the log stream from which data |
| | is being displayed. |
| | |
| | The keyword "ASIS" will follow the log stream |
| | name if the records are being read ASIS. |
| | ASIS specifies that no record decompression |
| | has been requested. |
+------------------+--------------------------------------------------+
| Retention | The log stream retention period. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Available | The time and date of the first and last records |
| | in the physical log stream. |
| | |
| | Commands that display the contents of log |
| | streams will only display those records that |
| | are relevant to the specific command. The log |
| | stream may contain other records. |
| | |
| | The available time and date information may not |
| | reflect the actual usable data records if the |
| | log stream contains data different than what |
| | corresponds to the active command. |
+------------------+--------------------------------------------------+
| Searched | The searched range of records processed. |
+------------------+--------------------------------------------------+
| Displayed | The current "display window" of records being |
| | displayed. |
| | |
| | The time and date of the first and last records |
| | displayed. |
| | |
| | This value can be modified to position to a new |
| | starting time and date. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Lines | Specifies the maximum number of data rows |
| | to be displayed. |
+------------------+--------------------------------------------------+
| Limit | Specifies the maximum number of records to be |
| | read in order to satisfy the specified "Lines" |
| | value. |
| | The value "NONE" indicates that no limit or |
| | "0" was specified. |
+------------------+--------------------------------------------------+
| Period | Specifies the time period for which records are |
| | to be displayed. |
| | The value "NONE" indicates that no time period |
| | was specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: Date,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Date | The end date of an interval. |
+------------------+--------------------------------------------------+
| Time | The end time of an interval. |
+------------------+--------------------------------------------------+
| Trans | The number of transactions executed. |
+------------------+--------------------------------------------------+
| Lifetime | The average transaction lifetime. |
+------------------+--------------------------------------------------+
| CPUtime | The average CPUTIME used by a transaction. |
+------------------+--------------------------------------------------+
| IOCount | The number of I/Os executed. |
+------------------+--------------------------------------------------+
| Abends | The number of abends. |
+------------------+--------------------------------------------------+
| Thrsh | The number of thresholds exceeded. |
+------------------+--------------------------------------------------+
| CPU%JOB | The average percent of the system CPU used by |
| | the address space during the interval. |
+------------------+--------------------------------------------------+
| Interval | The length of the system interval. |
+------------------+--------------------------------------------------+
| TranRate | The number of transactions per second. |
+------------------+--------------------------------------------------+
| AtMxt | The number of times at max task during the |
| | interval. |
+------------------+--------------------------------------------------+
| IORate | The I/O rate per second. |
+------------------+--------------------------------------------------+
| DispTime | The average Dispatch time |
+------------------+--------------------------------------------------+
| Suspend | The average suspend time |
+------------------+--------------------------------------------------+
| EXWTime | The average CICS exception wait time |
+------------------+--------------------------------------------------+
| DspDelay | The average dispatch delay time - 1st |
+------------------+--------------------------------------------------+
| FCPTime | The average file I/O wait time |
+------------------+--------------------------------------------------+
| MROTime | The average inter-region wait time |
+------------------+--------------------------------------------------+
| MxTDelay | The average MXT delay 1st dispatch |
+------------------+--------------------------------------------------+
| RMITIME | The average Resource Manager Interface |
+------------------+--------------------------------------------------+
| RMISUSP | The average Resource Manager Suspend |
+------------------+--------------------------------------------------+
| TermTime | The average terminal I/O wait time |
+------------------+--------------------------------------------------+
| TCLDelay | The average tran class delay 1st disp |
+------------------+--------------------------------------------------+
| RMITOTAL | The average RMI time - Total |
+------------------+--------------------------------------------------+
| RMICPSM | The average RMI time - CICSPlex SM |
+------------------+--------------------------------------------------+
| RMIDBCTL | The average RMI time - DBCTL |
+------------------+--------------------------------------------------+
| RMIDB2 | The average RMI time - DB2 |
+------------------+--------------------------------------------------+
| RMIEXDLI | The average RMI time - EXEC DLI |
+------------------+--------------------------------------------------+
| RMIMQM | The average RMI time - MQ |
+------------------+--------------------------------------------------+
| RMIOTHER | The average RMI time - Other |
+------------------+--------------------------------------------------+
| RMITCPIP | The average RMI time - TCP/IP sockets |
+------------------+--------------------------------------------------+
| WTRTime | The average waiting to run time |
+------------------+--------------------------------------------------+
| GSVITIME | The average global user exit monitor time |
+------------------+--------------------------------------------------+
| GSVICPU | The average global user exit cpu time |
+------------------+--------------------------------------------------+
| TempStg | The temporary storage size in use. |
+------------------+--------------------------------------------------+
| Aux% | The auxiliary temporary storage usage |
| | percentage. |
+------------------+--------------------------------------------------+
| SOS | The number of short-on-storage (SOS) conditions |
| | for the interval. |
+------------------+--------------------------------------------------+
| CDSA% | The percentage of CICS DSA storage in use. |
+------------------+--------------------------------------------------+
| UDSA% | The percentage of user DSA storage in use. |
+------------------+--------------------------------------------------+
| SDSA% | The percentage of shared DSA storage in use. |
+------------------+--------------------------------------------------+
| RDSA% | The percentage of read-only DSA storage in use. |
+------------------+--------------------------------------------------+
| ECDSA% | The percentage of Extended CICS DSA storage in |
| | use. |
+------------------+--------------------------------------------------+
| EUDSA% | The percentage of Extended User DSA storage in |
| | use. |
+------------------+--------------------------------------------------+
| ESDSA% | The percentage of Extended Shared DSA storage in |
| | use. |
+------------------+--------------------------------------------------+
| ERDSA% | The percentage of Extended read-only DSA storage |
| | in use. |
+------------------+--------------------------------------------------+
| PVT% | The percentage of private storage in use. |
+------------------+--------------------------------------------------+
| PVTUser | The amount of private user storage allocated. |
+------------------+--------------------------------------------------+
| PVTSys | The amount of private system storage allocated. |
+------------------+--------------------------------------------------+
| EPVT% | The percent of extended private storage in use. |
+------------------+--------------------------------------------------+
| EPVTUser | The amount of extended private user storage |
| | allocated. |
+------------------+--------------------------------------------------+
| EPVTSys | The amount of extended private system storage |
| | allocated. |
+------------------+--------------------------------------------------+
| PageIn | The non-VAM page in count. |
+------------------+--------------------------------------------------+
| SwapIn | The page swap in count. |
+------------------+--------------------------------------------------+
| Swaps | The number of address space swaps. |
+------------------+--------------------------------------------------+
| Stolen | The number of pages stolen from memory. |
+------------------+--------------------------------------------------+
| Applid | The applid of the CICS region. |
+------------------+--------------------------------------------------+
| DB2 | The DB2 subsystem ID in use. |
+------------------+--------------------------------------------------+
| Length | The record length. |
+------------------+--------------------------------------------------+
| BlockID | Block ID assigned to the log record. |
+------------------+--------------------------------------------------+
| SubRec | Sub-record number within a block. |
+------------------+--------------------------------------------------+
| CmpLen | Length of the compressed record |
+------------------+--------------------------------------------------+
| Cmp% | Compression percentage |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DRO | Delete records older than the entry selected. |
| | Invokes the LGDRO command. |
+------------------+--------------------------------------------------+
| PRint | Displays the detail screen for a record, prints |
| | the detail report to a sysout data set and then |
| | returns to the display screen. If a SYSOUT |
| | print data set was not open this line command |
| | will cause it to be opened. All subsequent |
| | PRINT line commands will print to the same |
| | SYSOUT data set until a PRINT CLOSE command is |
| | issued or until the session terminates. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Dump | Dump the contents of a record. |
+------------------+--------------------------------------------------+
| SD | Select and dump. |
| | |
| | A detailed report followed by a dump of the |
| | contents of the record is displayed. |
+------------------+--------------------------------------------------+
| Idb2 | Invoke the IDB2 (SYSVIEW for DB2) command to |
| | display thread history. |
+------------------+--------------------------------------------------+
| Select | Display the detail screen for a record. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| BACkward | Read the previous block of records in the log |
| PREVious | starting with the first record displayed on the |
| | screen. The number of records read is |
| | controlled by the LINES option, which can be set |
| | using the OPTIONS subcommand. |
+------------------+--------------------------------------------------+
| EOF | Go to the end of the log. |
| EOL | |
+------------------+--------------------------------------------------+
| FORward | Read the next block of records in the log |
| NEXT | starting with the last record displayed on the |
| | screen. The number of records read is |
| | controlled by the LINES option, which can be set |
| | using the OPTIONS subcommand. |
+------------------+--------------------------------------------------+
| OPTions | Set and display miscellaneous command options. |
+------------------+--------------------------------------------------+
| POSition | Position to a time and date. |
| | |
| | Syntax : POSITION time [date] |
| | |
| | time - The time value must be specified |
| | using the time format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | If "*" is specified, the current |
| | time will be used. |
| | |
| | The time value can also be |
| | specified using one of the |
| | following values: |
| | 12AM | 1AM | 2AM | ... | 11AM |
| | 12PM | 1PM | 2PM | ... | 11PM |
| | NOON | MIDNIGHT |
| | |
| | Query current time format |
| | |
| | date - The date value must be specified |
| | using the date format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | If "*" is specified, the current |
| | date will be used. |
| | |
| | Query current date format |
| | |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| TOF | Go to the top of the log. |
| TOL | |
+------------------+--------------------------------------------------+
| FILTER | Display a "filter" screen to allow the entering |
| | command syntax parameters to filter the data. |
+------------------+--------------------------------------------------+

OPTIONS Subcommand

The OPTIONS subcommand sets and displays miscellaneous command


options.

Entering the OPTIONS subcommand with no parameters displays the


current option values.

Multiple option values can be entered as a single command.

OPTIONS Subcommand format

+------------------+--------------------------------------------------+
| OPTIONS | [options] |
+------------------+--------------------------------------------------+

OPTIONS Subcommand Parameter Values

+------------------+--------------------------------------------------+
| Value | Explanation |
+------------------+--------------------------------------------------+
| LINEs | Specifies the maximum number of data rows to |
| | be displayed. |
| | |
| | Syntax : OPTIONS LINES count |
| | |
| | Default : 25000 |
| | Minimum : 1 |
| | Maximum : 1000000 |
| | |
+------------------+--------------------------------------------------+
| LIMit | Specifies the maximum number of records to be |
| | read. |
| | |
| | Syntax : OPTIONS LIMIT count |
| | |
| | Default : 1000000 |
| | |
+------------------+--------------------------------------------------+
| PERiod | Specifies the time period for which records are |
| | to be displayed. |
| | |
| | Syntax : OPTIONS PERIOD hh:mm:ss |
| | |
| | Default : 0 (unlimited) |
| | |
| | Example values: |
| | |
| | NONE - No period (unlimited) |
| | 0 - No period (unlimited) |
| | 0.500000 - 0.5 seconds |
| | 60 - 60 seconds |
| | 120Sec - 120 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | 1Days - 1 day |
| | 1MONths - 1 month |
| | 1Years - 1 year |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| CUSHion | Specifies the time period cushion for which |
| | records are to be read for display. |
| | |
| | Data records stored in an MVS log stream are |
| | sequenced or sorted based on the actual time |
| | the record was written to the stream. |
| | |
| | This does not guarantee that the records |
| | are sorted in a time sequence based on the |
| | date and time information that is potentially |
| | contained within each record. |
| | |
| | For this reason, when a user wants to display |
| | a specific time period of data, additional |
| | records must be read on the front and back |
| | end of the read process to ensure that the |
| | records that might be out of sequence are |
| | included. |
| | |
| | The time period cushion specifies the extra |
| | records to be read. |
| | |
| | Syntax : OPTIONS CUSHION hh:mm:ss |
| | |
| | Example Cushion: |
| | |
| | Start time: 8AM |
| | Period : 1 Hour |
| | Cushion : 5 minutes |
| | |
| | Read Begin : 07:55:00 |
| | -- Discard records |
| | Display Begin : 08:00:00 |
| | -- Display records |
| | Display End : 09:00:00 |
| | -- Discard records |
| | Read End : 09:05:00 |
| | |
| | Example values: |
| | |
| | NONE - No cushion |
| | 0 - No cushion |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| ELAPsed | Specifies the elapsed time limit for reading |
| ELAPsedlimit | or searching the log streams for desired data. |
| | |
| | If the log stream being searched is very large, |
| | the search time required can be substantial. |
| | This is especially true if a large number of |
| | data LINES has been requested and the number |
| | of data records that would satisfy the search |
| | request are spread across the entire log stream. |
| | |
| | The log browse search will be interrupted |
| | when the elapsed time limit is reached. |
| | |
| | The search can be continued using the |
| | subcommands: NEXT or PREVIOUS |
| | |
| | Syntax : OPTIONS ELAPSED hh:mm:ss |
| | |
| | Default : 00:00:30 |
| | |
| | Example values: |
| | |
| | NONE - No limit |
| | 0 - No limit |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| RECORDTime | Specifies whether the "start" or "end" date |
| RECTime | and time should be used for the records. |
| | |
| | Not all records have a start and an end time. |
| | |
| | Records that are interval based typically do |
| | have a start and end time. |
| | |
| | Records that are event based typically do not. |
| | |
| | Syntax : OPTIONS RECTIME END|START |
| | |
| | Valid values are: |
| | |
| | END (default) |
| | START |
| | |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC |
| | variable. The variable created or updated is |
| | named SYSV_OPTIONS_cmdname. EXTRACT is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. EXTRACT can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+------------------+--------------------------------------------------+
| FILTER | Specifies that the "filter" display screen |
| | is to be displayed to allow the entering of |
| | command syntax parameters. |
| | |
| | The "filter" display screen will be displayed |
| | each time the command is invoked unless the |
| | NOFILTER parameter is entered as part of the |
| | primary command syntax. |
| | |
| | Syntax : OPTIONS FILTER |
| | |
+------------------+--------------------------------------------------+
| NOFILTER | Specifies that the "filter" display screen |
| | is not to be displayed. |
| | |
| | The NOFILTER option can be overridden by |
| | entering the FILTER parameter as part of the |
| | primary command syntax. |
| | |
| | The subcommand FILTER can also be used to |
| | display the "filter" display screen. |
| | |
| | Syntax : OPTIONS NOFILTER |
| | |
+------------------+--------------------------------------------------+
| RESET | Request to option values to the defaults. |
| | |
| | Syntax : OPTIONS RESET |
| | |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
Related Information

SYSVIEW Usage of MVS Log Streams

Security Requirements

The display of log record information can be controlled by security


definitions. The number of security calls can be large. A security
call is made for each log record to verify the authorization to
display the jobname. The security checks are also performed if
the log record is selected for detailed display.

To enable security validation for CICS log displays, set the following
option in the parmlib member:

sysview.CNM4BPRM(OPTIONS)

SECURE-CICSLOG-BY-JOBNAME Yes

If the security option for "Display Unauthorized Jobs" is set to YES,


then the security check for the jobname is bypassed at the summary
screen level. This means that summary information can be displayed
for all records, but detailed information is controlled by security
definitions. This can reduce the number of security checks being made.

For security requirements, follow the link:

CSYSDATA command security


CSYSDMON

CSYSDMON Command

The CSYSDMON display provides information about the SYSVIEW


CICS System Data Collection processes.

The System Data Collector is comprised of several processes.


This display will show the amount of elapsed time and CPU time
used by each process on its last invocation.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CSYSDMON | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+
| Clocktime | The amount of wall clock time the job has been |
| | executing. |
+------------------+--------------------------------------------------+
| GSVITime | The elapsed time since the data collector |
| | was started. |
+------------------+--------------------------------------------------+
| CPUTime | The amount of CPU time that has been consumed |
| | by the CICS address space since the data |
| | collector was started. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Name,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Name | System data collection name |
| | Possible values are: |
| | SYSDATA-COLLECT - System data collection |
| | SYSDATA-RECORD - System data interval record |
| | SYSTEM-CONDITION - System data |
| | SYSTEM-CONNECT - Connections |
| | SYSTEM-FACILITY - CICS facilities |
| | SYSTEM-FILES - Files |
| | SYSTEM-IPCONN - IP Connections |
| | SYSTEM-PIPELINES - Pipelines |
| | SYSTEM-PROGRAMS - Programs |
| | SYSTEM-SOCKETS - Sockets |
| | SYSTEM-TCLASS - Transaction classes |
| | SYSTEM-TDATA - Transient data |
| | SYSTEM-TERMINALS - Terminals |
| | SYSTEM-TRANS - Transactions |
| | TRAN-REQUIRED - Required transactions |
| | TRAN-SUMMARY - Transaction summary records |
| | TRAN-SYSTEM - Transaction system metrics |
| | TRAN-THRESHOLDS - Dynamic transaction |
| | thresholds |
| | TRAN-TSUMDATA - Transaction summary data |
| | USER_DATA - User data |
| | |
| | TASK-GSVCLOGT - Message logging task |
| | TASK-GSVCSCHT - Scheduler task |
| | TASK-GSVCSDCS - System data collection task |
| | TASK-GSVCTPPT - Transaction post processing |
| | task |
| | TASK-GSVCXDIS - External data interface task |
+------------------+--------------------------------------------------+
| Status | The status of the collection type. |
| | |
| | If the collection type is a task, then the |
| | status is the current status of the task. |
| | |
| | If the collection type is an event that is |
| | scheduled by the event scheduler, then the |
| | status is the current status of the schedule |
| | event. |
| | |
+------------------+--------------------------------------------------+
| Count | The number of times the process has been |
| | executed. |
+------------------+--------------------------------------------------+
| TCPUTime | The total CPU time used by the collection |
| | process. |
+------------------+--------------------------------------------------+
| Pct% | The percentage of the CICS CPU time used |
| | by the collection event. |
| | |
| | pct% = (TCPUTime * 10000) |
| | ------------------ |
| | CICS CPU Time |
+------------------+--------------------------------------------------+
| CPTime | The total task CPU time. |
+------------------+--------------------------------------------------+
| EnclTime | The total enclave CPU time. |
+------------------+--------------------------------------------------+
| ePct% | The percent of the total CPU time used by the |
| | task that executed on an enclave. |
| | |
| | ePct% = EnclTime * 100 |
| | --------------------- |
| | CpuTime |
| | |
+------------------+--------------------------------------------------+
| zIIPonCP | The total enclave CPU time that ran on a |
| | general processor that was eligible to run on a |
| | zIIP processor. |
+------------------+--------------------------------------------------+
| zIIPTime | The total enclave CPU time running on a |
| | zIIP processor. |
+------------------+--------------------------------------------------+
| zPct% | The percent of the total CPU time used by the |
| | task that executed on a zIIP processor. |
| | |
| | zPct% = zIIPTime * 100 |
| | --------------------- |
| | TCpuTime |
| | |
+------------------+--------------------------------------------------+
| zSwitch | The number of zIIP mode switches. |
+------------------+--------------------------------------------------+
| Enqueues | Enqueue count |
+------------------+--------------------------------------------------+
| EnqDLAR | Enqueue count - Datalib |
+------------------+--------------------------------------------------+
| EnqDSPR | Enqueue count - DataSpace |
+------------------+--------------------------------------------------+
| EnqMSGR | Enqueue count - Messaging |
+------------------+--------------------------------------------------+
| EnqSTGR | Enqueue count - Storage |
+------------------+--------------------------------------------------+
| EnqVSPR | Enqueue count - Virtual storage |
+------------------+--------------------------------------------------+
| Date | The date and time of the last invocation. |
| Time | |
+------------------+--------------------------------------------------+
| Elapsed | The elapsed time of the last invocation. |
+------------------+--------------------------------------------------+
| CPUTime | The CPU time used during the last invocation. |
+------------------+--------------------------------------------------+
| AElapsed | The average elapsed time for the collection |
| | process on a single collection interval. |
+------------------+--------------------------------------------------+
| ACPUTime | The average CPU time used by the collection |
| | process on a single collection interval. |
+------------------+--------------------------------------------------+
| TElapsed | The total elapsed time for the collection |
| | process. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CTAGS

CTAGS Command

The CTAGS command displays defined CICS region tagging.

CICS regions can be tagged to help identify the purpose of the region.
A CICS YAML file is used to create tagging definitions.

This command requires CICS TS 6.1 or higher.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTAGS | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Type,A,Value,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Type | The tag type. |
+------------------+--------------------------------------------------+
| Value | The tag value for the type. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands
+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CTASKENT

CTASKENT Command

The CTASKENT command displays a list of task table entries (TASENTRY).

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTASKENT | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Index,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname where the task is executing. |
+------------------+--------------------------------------------------+
| Name | The control block ID. |
+------------------+--------------------------------------------------+
| Index | The task index number. |
+------------------+--------------------------------------------------+
| Status | The status of the entry. If ACTIVE, then the |
| | entry is currently active. If blank, then the |
| | the entry is inactive. |
+------------------+--------------------------------------------------+
| Domain | The CICS domain that owns the entry. |
+------------------+--------------------------------------------------+
| Tran | The transaction ID that is being executed by the |
| | entry. |
+------------------+--------------------------------------------------+
| Task# | The task number. |
+------------------+--------------------------------------------------+
| TCBID | The TCB ID used for trace. |
+------------------+--------------------------------------------------+
| CPUTime | The amount of CPU time used by the task, |
| | in seconds. |
+------------------+--------------------------------------------------+
| IntvLeft | The intervals left before runaway task occurs. |
+------------------+--------------------------------------------------+
| AICAStop | The number of stop runaway timer requests. |
+------------------+--------------------------------------------------+
| PurgeReq | The number of start purge protection requests. |
| | If zero, then the task is not protected. |
+------------------+--------------------------------------------------+
| WaitType | Specifies the reason the task is in a WAIT |
| WaitName | status. |
+------------------+--------------------------------------------------+
| KTCB | The address of the current KTCB entry for the |
| | task. |
+------------------+--------------------------------------------------+
| XM-Token | The XM transaction token. |
+------------------+--------------------------------------------------+
| TCA | The TCA address. |
+------------------+--------------------------------------------------+
| DSTSK | The dispatcher task area address. |
+------------------+--------------------------------------------------+
| TASENTRY | The address of the TASENTRY control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

The following actions can be used to cancel a CICS task.


The actions are listed in order of relative cancellation
power. Cancelling a task can cause damage to the CICS region.
In some cases a deferred abend request must be scheduled.
The deferred abend code will be set to "GSVC".
Where possible, SYSVIEW uses the CICS CEKL process to cancel tasks.

Task cancellation is done at your own risk!

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| PURge | Purge the selected task. |
| | |
| | Method: |
| | |
| | CEKL SET TASK(number) PURGE |
| | |
+------------------+--------------------------------------------------+
| FORcepur | Force purge the selected task. |
| | |
| | Method: |
| | |
| | CEKL SET TASK(number) FORCEPURGE |
| | |
+------------------+--------------------------------------------------+
| Cancel | Cancel the selected task. |
| | |
| | Progressive methods: |
| | |
| | CEKL SET TASK(number) PURGE |
| | |
| | If task still exists then |
| | CEKL SET TASK(number) FORCEPURGE |
| | |
+------------------+--------------------------------------------------+
| Kill | Kill the selected task. |
| | |
| | Progressive methods: |
| | |
| | CEKL SET TASK(number) PURGE |
| | |
| | If task still exists then |
| | CEKL SET TASK(number) FORCEPURGE |
| | |
| | If task still exists then |
| | CEKL SET TASK(number) KILL |
| | |
+------------------+--------------------------------------------------+
| CKill | Kill the selected task. |
| CICSKill | |
| | Method: |
| | |
| | CEKL SET TASK(number) KILL |
| | |
| | A PURGE or FORCEPUR should be attempted prior |
| | to issuing a CKILL. |
| | |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CTASKENT command security


CTASKS

CTASKS Command

The CICS Active Tasks screen displays information about active and
suspended tasks.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTASKS | [ REGion | SYStem ] |
| | |
| | [ XSYStem | NOXSYstem ] |
| | |
| | [ GROUP group ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Max Tasks (displayed only in REGION mode)


+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Current | Specifies the current number of tasks |
| | contributing to the maximum tasks value. |
+------------------+--------------------------------------------------+
| High | Specifies the high water mark of concurrent |
| | tasks. |
+------------------+--------------------------------------------------+
| Limit | Specifies the maximum tasks limit as defined in |
| | the System Initialization Table (SIT). |
| | |
| | The limit value can be altered. |
| | The value must be in the range 1 to 2000. |
+------------------+--------------------------------------------------+
| AtLimit | Specifies the number of times that the |
| | concurrent number of tasks reached the defined |
| | limit. |
+------------------+--------------------------------------------------+

Short On Storage (displayed only in REGION mode)


+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Short On Storage | Indicates whether CICS is currently short on |
| | storage. |
| | |
| | Possible values are: |
| | |
| | none CICS is not short on storage |
| | DSA CICS DSA is short on storage |
| | EDSA CICS EDSA is short on storage |
| | |
| | Related topics: CICS DSAs CICS Subpools |
+------------------+--------------------------------------------------+

Resource Usage Rates (displayed only in REGION mode)


+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| CPU | CPU usage for the address space, expressed as a |
| | percentage. This is the average value for the |
| | last data collection interval. |
+------------------+--------------------------------------------------+
| Paging | Specifies the paging rate per second for the |
| | address space. This is the average value for |
| | the last data collection interval. |
+------------------+--------------------------------------------------+
| IORate | Specifies the I/O rate per second for the |
| | address space. This is the average value for |
| | the last data collection interval. |
+------------------+--------------------------------------------------+
| TranRate | Specifies the transaction rate per second. This |
| | is the average value for the last data |
| | collection interval. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Specifies the CICS jobname where the task is |
| | executing. |
+------------------+--------------------------------------------------+
| A | Specifies whether the transaction is currently |
| | active. The field contains a "]" if the |
| | transaction is currently executing. If an "e" |
| | appears in this column, an error was encountered |
| | when trying to collect information about this |
| | transaction. This also could indicate that the |
| | transaction ended while attempting to collect |
| | information. |
+------------------+--------------------------------------------------+
| Tran | Specifies the transaction ID of the task. |
+------------------+--------------------------------------------------+
| Task# | Specifies the number assigned to the task. |
+------------------+--------------------------------------------------+
| Program | Specifies the current program being executed |
| | by the transaction. |
+------------------+--------------------------------------------------+
| Term | Specifies the terminal ID of the task. |
+------------------+--------------------------------------------------+
| WaitType | Specifies the reason the task is in a WAIT |
| WaitName | status. |
+------------------+--------------------------------------------------+
| CPUTime | Specifies the amount of CPU time used by the |
| | transaction, in seconds. |
| | |
| | The status is based on exception rules for |
| | metric: CICS_TRAN_TASK_CpuTime |
+------------------+--------------------------------------------------+
| LifeTime | Specifies the current lifetime of the |
| | transaction. |
| | |
| | The status is based on exception rules for |
| | metric: CICS_TRAN_CICS_LifeTime |
| | |
| | Status will not be evaluated for transactions |
| | indicated as long running transactions in the |
| | LongRun field. |
+------------------+--------------------------------------------------+
| WaitTime | Specifies the time that the task has been |
| | waiting since the last suspend. |
+------------------+--------------------------------------------------+
| ExecTime | If the task is currently dispatched, the |
| | ExecTime value contains the elapsed time since |
| | last dispatch. |
| | |
| | In the case where a task is in a "hard loop", |
| | the CPU time may not get updated. This value |
| | will give notice of a loop. |
| | |
| | This is a real-time only metric. No historical |
| | information is maintained since the execution |
| | time only exists while the transaction is |
| | executing. A real-time or dynamic threshold |
| | definition can be created and will be |
| | evaluated in real-time. |
| | |
| | Metric: CICS_TRAN_ExecutionTime |
+------------------+--------------------------------------------------+
| RunTime | Specifies the time that the task has been |
| | eligible to run. |
| | |
| | RunTime = lifetime - Dispatch Delay time |
+------------------+--------------------------------------------------+
| SuspTime | Specifies the time the task spent suspended. |
+------------------+--------------------------------------------------+
| UOWTime | Specifies the elapsed time or age of the |
| | unit-of-work. This is the time since the UOW |
| | entered its current state, or since the start |
| | of the UOW. |
| | |
| | This is a real-time only metric. No historical |
| | information is maintained since the execution |
| | time only exists while the transaction is |
| | executing. A real-time or dynamic threshold |
| | definition can be created and will be |
| | evaluated in real-time. |
| | |
| | Metric: CICS_TRAN_UOWTime |
+------------------+--------------------------------------------------+
| IOReqs | Specifies the number of requests for the task. |
| | |
| | The status is based on exception rules for |
| | metric: CICS_TRAN_FILE_Reqs |
+------------------+--------------------------------------------------+
| Pri | Specifies the task priority. |
+------------------+--------------------------------------------------+
| Userid | Specifies the userid of the task. |
+------------------+--------------------------------------------------+
| ClientType | Specifies the client type. |
| | |
| | Possible values are: |
| | |
| | NONE - None |
| | TERMINAL - Terminal |
| | TRANDATA - TranData |
| | START - Start |
| | STARTTERM - Start Terminal |
| | SCHEDULER - Scheduler |
| | XMRUNTRAN - XM Run Transaction |
| | BRIDGE - Bridge |
| | SOCKET - Socket |
| | WEB - Web |
| | RSSUR - RRS UR |
| | LU61 - LU61 Session |
| | APPC - APPC Session |
| | MRO - MRO Session |
| | IPECI - IP ECI |
| | IIRR - IIRR |
| | RZTRPORT - RZ Instore TRPort |
| | IS - IS Session |
+------------------+--------------------------------------------------+
| Attach | The elapsed time since the task was attached. |
+------------------+--------------------------------------------------+
| AttDate | The date and time of task attach. |
| AttTime | |
+------------------+--------------------------------------------------+
| Isolate | Specifies transaction isolation. |
| | |
| | Possible values are: |
| | |
| | Active - The task is currently executing |
| | in a subspace |
| | |
| | Eligible - The task is eligible to execute |
| | in a subspace |
| | |
| | Isolate - The task is to be isolated from |
| | other tasks |
+------------------+--------------------------------------------------+
| SubSpace | Specifies the name of the subspace of the task. |
+------------------+--------------------------------------------------+
| ExecKey | Specifies the execution key. |
| | |
| | Possible values are: |
| | |
| | CICS |
| | USER |
+------------------+--------------------------------------------------+
| DataKey | Specifies the data key. |
| | |
| | Possible values are: |
| | |
| | CICS |
| | USER |
+------------------+--------------------------------------------------+
| DataLoc | Specifies the location of the data for the task. |
| | |
| | Possible values are: |
| | |
| | ANY |
| | BELOW |
+------------------+--------------------------------------------------+
| DTA | The address of the Dispatcher Task Area. |
+------------------+--------------------------------------------------+
| TXn | The address of the TXn control block. |
+------------------+--------------------------------------------------+
| TCA | The address of the System TCA control block. |
+------------------+--------------------------------------------------+
| TASENTRY | The address of the TASENTRY control block. |
+------------------+--------------------------------------------------+
| TCBID | The TCB ID used for trace that is associated |
| | with the task (TASENTRY). |
+------------------+--------------------------------------------------+
| TClass | Specifies the transaction class. |
| | |
| | If the transaction is defined with the |
| | transaction class value of DFHTCL00, blanks |
| | will be displayed. |
| | |
| | DFHTCL00 is a reserved transaction class used |
| | to indicate that the transaction does not |
| | belong to any transaction class. |
+------------------+--------------------------------------------------+
| Umb-Name | Specifies the umbrella name. |
+------------------+--------------------------------------------------+
| Umb-Type | Specifies the umbrella type. |
+------------------+--------------------------------------------------+
| ONetwork | Origin network id. |
+------------------+--------------------------------------------------+
| OApplid | Origin applid. |
+------------------+--------------------------------------------------+
| OTran | Origin transaction id. |
+------------------+--------------------------------------------------+
| OTask | Origin task number. |
+------------------+--------------------------------------------------+
| LocalUOW | Specifies the local unit of work ID. |
+------------------+--------------------------------------------------+
| Unit-of-Work-Id | Specifies the remote CICS unit of work ID. |
+------------------+--------------------------------------------------+
| Token-Value | Specifies the subset of the unit of work. |
+------------------+--------------------------------------------------+
| Seq# | Specifies the sequence number. |
+------------------+--------------------------------------------------+
| Ver | Specifies the CICS version number. |
+------------------+--------------------------------------------------+
| TMA | The address of the CICS Task Monitor Area. |
+------------------+--------------------------------------------------+
| MCB | The address of the SYSVIEW Monitor Control |
| | Block. |
+------------------+--------------------------------------------------+
| RToken1 | Specifies the recovery token. |
+------------------+--------------------------------------------------+
| RToken2 | Specifies the recovery token. |
+------------------+--------------------------------------------------+
| SysID | Specifies the system ID for the remote CICS. |
+------------------+--------------------------------------------------+
| LTerm | Specifies the linked terminal name. |
+------------------+--------------------------------------------------+
| Abend | Indicates that the transaction is abending or |
| | in the process of being purged, forcepurged, |
| | cancelled, or killed. |
+------------------+--------------------------------------------------+
| Sys | Indicates that the transaction is a system task. |
+------------------+--------------------------------------------------+
| LongRun | Specifies if the transaction is defined as a |
| | long running transaction. |
| | |
| | Long running transactions are defined using |
| | the CICS Transaction Options command: CTRANOPT |
| | |
| | Exceptions are not evaluated for the following |
| | metrics when the transaction has been defined |
| | as long running: |
| | |
| | CICS_TRAN_CICS_LifeTime |
+------------------+--------------------------------------------------+
| Debug | Indicates that an application debugger is active |
| | for the transaction. |
+------------------+--------------------------------------------------+
| SrvClass | Specifies the WLM service class. |
+------------------+--------------------------------------------------+
| RptClass | Specifies the WLM report class. |
+------------------+--------------------------------------------------+
| Commarea | The address of the communications area. |
+------------------+--------------------------------------------------+
| TWA | The address of the Transaction Work Area. |
+------------------+--------------------------------------------------+
| TimeOutD | Specifies the time out expiration date. |
+------------------+--------------------------------------------------+
| TimeOutT | Specifies the time out expiration time. |
+------------------+--------------------------------------------------+
| CDSA | Specifies the current CICS DSA storage in use. |
+------------------+--------------------------------------------------+
| UDSA | Specifies the current User DSA storage in use. |
+------------------+--------------------------------------------------+
| ECDSA | Specifies the current Extended CICS DSA storage |
| | in use. |
+------------------+--------------------------------------------------+
| EUDSA | Specifies the current Extended User DSA storage |
| | in use. |
+------------------+--------------------------------------------------+
| GCDSA | Specifies the current AboveBar CICS DSA storage |
| | in use. |
+------------------+--------------------------------------------------+
| GUDSA | Specifies the current AboveBar User DSA storage |
| | in use. |
+------------------+--------------------------------------------------+
| Subpool | Specifies the generic CICS storage subpool name |
| | used for this transaction. |
+------------------+--------------------------------------------------+
| DFHEISDS | The address of the Exec Interface Structure |
| | control block. |
+------------------+--------------------------------------------------+
| EIBUser | The address of the user Exec Interface Block |
| | control block. |
+------------------+--------------------------------------------------+
| EIBSys | The address of the system Exec Interface Block |
| | control block. |
+------------------+--------------------------------------------------+
| DFHEIUS | The address of the DFHEIUS control block. |
+------------------+--------------------------------------------------+
| EIS | The address of Exec Interface Storage. |
+------------------+--------------------------------------------------+
| EIUser | The address of Exec Interface User Storage. |
+------------------+--------------------------------------------------+
| The following EIB fields are obtained from the user EIB. |
+------------------+--------------------------------------------------+
| EIBFN | The last EXEC CICS command issued by the task. |
+------------------+--------------------------------------------------+
| EIBFNDesc | The description of the last EXEC CICS function |
| | as defined in the EIBCODES parmlib member. |
+------------------+--------------------------------------------------+
| EIBRCODE | The CICS response code returned after the last |
| | EXEC CICS command request. |
+------------------+--------------------------------------------------+
| EIBRESP | The EXEC CICS response condition. |
| | Common EIBRESP codes |
+------------------+--------------------------------------------------+
| EIBRESP2 | More detailed information to the EXEC CICS |
| | response condition. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

The following actions can be used to cancel a CICS task.


The actions are listed in order of relative cancellation
power. Cancelling a task can cause damage to the CICS region.
In some cases a deferred abend request must be scheduled.
The deferred abend code will be set to "GSVC".
Where possible, SYSVIEW uses the CICS CEKL process to cancel tasks.

Task cancellation is done at your own risk!

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| PURge | Purge the selected task. |
| | |
| | Method: |
| | |
| | CEKL SET TASK(number) PURGE |
| | |
+------------------+--------------------------------------------------+
| FORcepur | Force purge the selected task. |
| | |
| | Method: |
| | |
| | CEKL SET TASK(number) FORCEPURGE |
| | |
+------------------+--------------------------------------------------+
| Cancel | Cancel the selected task. |
| | |
| | Progressive methods: |
| | |
| | CEKL SET TASK(number) PURGE |
| | |
| | If task still exists then |
| | CEKL SET TASK(number) FORCEPURGE |
| | |
+------------------+--------------------------------------------------+
| Kill | Kill the selected task. |
| | |
| | Progressive methods: |
| | |
| | CEKL SET TASK(number) PURGE |
| | |
| | If task still exists then |
| | CEKL SET TASK(number) FORCEPURGE |
| | |
| | If task still exists then |
| | CEKL SET TASK(number) KILL |
| | |
+------------------+--------------------------------------------------+
| CKill | Kill the selected task. |
| CICSKill | |
| | Method: |
| | |
| | CEKL SET TASK(number) KILL |
| | |
| | A PURGE or FORCEPUR should be attempted prior |
| | to issuing a CKILL. |
| | |
+------------------+--------------------------------------------------+
| MAT | Schedule an event with Mainframe Application |
| | Tuner to monitor the transaction. |
| | Invokes the CLIST CAMAT |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| CHANnel | Invokes the CCHANNEL command to show the |
| | channels associated with the selected task. |
+------------------+--------------------------------------------------+
| CONTain | Invokes the CCONTAIN command to show the |
| | containers associated with the selected task. |
+------------------+--------------------------------------------------+
| DB2 | Invokes the CDB2CSUB command to show the DB2 |
| | connects or threads in use. |
+------------------+--------------------------------------------------+
| EIB | Invokes the MAP command for the control block |
| | DFHEIBLK. |
+------------------+--------------------------------------------------+
| EIS | Invokes the MAP command for the control block |
| | DFHEISTG. |
+------------------+--------------------------------------------------+
| ELements | Invokes the CELEMENT command to display storage |
| | elements. |
+------------------+--------------------------------------------------+
| Enqueue | Invokes the CENQUEUES command to show enqueues |
| NQ | that the selected transaction owns or is |
| | currently waiting on. |
+------------------+--------------------------------------------------+
| History | Invokes the CTRANLOG command to display records |
| | for the selected transaction ID for a period of |
| | 1 day. |
+------------------+--------------------------------------------------+
| Select | Invokes the SMFRPT command to display a |
| | real-time report of detailed transaction |
| | information for the selected task. |
+------------------+--------------------------------------------------+
| SUbpools | Invokes the CSUBPOOL command to display subpools |
| | that are owned by the selected task. |
+------------------+--------------------------------------------------+
| UOW | Invokes the CUOW command selecting units of work |
| | with a matching transaction number. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| OPTions | Set and display command options. |
+------------------+--------------------------------------------------+

OPTIONS Subcommand

Use the OPTIONS subcommand to set and display CTASKS command display
and processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [options] |
+---------------+-----------------------------------------------------+

OPTIONS Parameter Values

The following table lists and explains the valid OPTIONS parameter
values. Any number of the values can be specified in any order.
The current settings of all options are always displayed in response
to the OPTIONS subcommand.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| System | Display system tasks. |
| NOSystem | Do not display system tasks. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_CTASKS. EXTRACT is only valid |
| | when the product is running under a TSO CLIST or |
| | REXX exec. EXTRACT can be specified alone or in |
| | combination with any other OPTIONS keywords. |
+---------------+-----------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CTASKS command security


CTCBMODE

CTCBMODE Command

The CTCBMODE command displays information about the CICS dispatcher


TCB modes.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTCBMODE | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Num,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Mode | The name of the TCB mode |
+------------------+--------------------------------------------------+
| Num | The TCB mode index number |
+------------------+--------------------------------------------------+
| Open | Indicates whether the TCB mode is an open |
| | TCB mode. |
| | Possible value are: |
| | OPEN - The mode is an OPEN |
| | NO - The mode is not OPEN |
| | blank - The mode has not been activated |
+------------------+--------------------------------------------------+
| Pool | The name of the TCB pool in which this |
| | TCB mode is a part of. |
| | Possible value are: |
| | OPEN - Open |
| | JVM - JVM |
| | XP - XPLink |
| | SSL - SSL |
| | THRD - Threaded |
| | blank - Not part of a pool |
+------------------+--------------------------------------------------+
| Attach | The current number of TCBs that are attached. |
+------------------+--------------------------------------------------+
| AttachH | The High Water Mark number of TCBs that have |
| | been attached. |
+------------------+--------------------------------------------------+
| InUse | The current number of TCBs in use |
+------------------+--------------------------------------------------+
| InUseH | The High Water Mark number of TCBs in use. |
+------------------+--------------------------------------------------+
| Allocate | The number of times a TCB has been allocated |
| | to a task. TCB allocates only apply to |
| | open TCB modes. |
+------------------+--------------------------------------------------+
| Failures | The number of MVS TCB attach failures |
+------------------+--------------------------------------------------+
| Unclean | The number of MVS TCBs that have been detached |
| | because the CICS transaction associated with |
| | the TCB abended. |
+------------------+--------------------------------------------------+
| Stolen | The number of MVS TCBs that have been stolen |
| | because it is required by another TCB mode. |
+------------------+--------------------------------------------------+
| Excess | The number of MVS TCBs that have been detached |
| | because of the CICS dispatcher excess TCB scans. |
+------------------+--------------------------------------------------+
| Other | The number of MVS TCBs that have been detached |
| | for other reasons: |
| | Possible reasons: |
| | * MAXOPENTCBS has been lowered |
| | * Too many TCBs attached in relation to the |
| | number of TCBs in use |
+------------------+--------------------------------------------------+
| Steals | The number of MVS TCBs that have been stolen |
| | from other TCB modes. |
+------------------+--------------------------------------------------+
| Mismatch | The number of TCB mismatches that have occurred |
+------------------+--------------------------------------------------+
| Waits | The number of operating system waits. |
+------------------+--------------------------------------------------+
| WaitTime | The amount of time that the TCB has been in |
| | MVS wait. |
+------------------+--------------------------------------------------+
| DispTime | The amount of time that the TCB has been |
| | dispatched by MVS. |
+------------------+--------------------------------------------------+
| CPUTime | The amount of CPU time used by this TCB. |
+------------------+--------------------------------------------------+
| TCBTime | The amount of CPU time used by this DS TCB. |
| | The time used by this TCB while running the |
| | default dispatcher task (DSTCB). |
+------------------+--------------------------------------------------+
| SUBD | The address of the SUBD control block |
+------------------+--------------------------------------------------+
| DS_TCB | The address of the DS_TCB control block |
+------------------+--------------------------------------------------+
| DSGTCBM | The address of the DSGTCBM control block |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.
Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CTCBPOOL

CTCBPOOL Command

The CTCBPOOL command displays information about the CICS dispatcher


TCB pools.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTCBPOOL | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Num,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Pool | The TCB pool name. |
+------------------+--------------------------------------------------+
| Num | The TCB pool index number |
+------------------+--------------------------------------------------+
| Attach | The current number of TCBs that are attached. |
+------------------+--------------------------------------------------+
| AttachH | The High Water Mark number of TCBs that have |
| | been attached. |
+------------------+--------------------------------------------------+
| InUse | The current number of TCBs in use |
+------------------+--------------------------------------------------+
| InUseH | The High Water Mark number of TCBs in use. |
+------------------+--------------------------------------------------+
| SITParm | The associate SIT paramater for the maximum |
| | TCBs value. |
+------------------+--------------------------------------------------+
| MaxTCBs | The maximum number of TCBs allowed in the pool. |
+------------------+--------------------------------------------------+
| Term | The number of TCBs that are currently in |
| | termination. |
+------------------+--------------------------------------------------+
| SuspOpen | The number of tasks awaiting an open TCB. |
+------------------+--------------------------------------------------+
| SuspPool | The number of TCB requests that are currently |
| | suspended because the system has reached the |
| | limit for the TCBs allowed in the pool. |
+------------------+--------------------------------------------------+
| SuspStg | The number of tasks suspended because MVS |
| | storage is constrained. |
+------------------+--------------------------------------------------+
| OPEN_POOL | The address of the OPEN_POOL control block |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CTCLASS

CTCLASS Command

The CTCLASS command displays the transaction class definition and


statistics maintained by the CICS DFHXM domain (Txn Manager) since
the last CICS statistics reset.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTCLASS | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Class,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Class | The name of the transaction class. |
+------------------+--------------------------------------------------+
| Number | The number of the transaction class. |
+------------------+--------------------------------------------------+
| Max | The number of tasks that can be active in the |
| | class. |
| | |
| | The maximum task value can be modified. The |
| | total of all class max values should not exceed |
| | the overall CICS max tasks value. |
+------------------+--------------------------------------------------+
| Active | The current number of active tasks in the class. |
+------------------+--------------------------------------------------+
| Act% | The percent of maximum transactions that are |
| | currently active. |
+------------------+--------------------------------------------------+
| High | The high water mark of active tasks. |
+------------------+--------------------------------------------------+
| AtMax | The number of times at maximum task value. |
+------------------+--------------------------------------------------+
| Count | The number of transaction definitions that |
| | reference this class. |
+------------------+--------------------------------------------------+
| QueCurr | The number of transactions currently queued. |
+------------------+--------------------------------------------------+
| QueMax | The maximum number of transactions that have |
| | been queued. |
+------------------+--------------------------------------------------+
| QueTot | The total number of transactions that have been |
| | queued. |
+------------------+--------------------------------------------------+
| PurgLim | The threshold value at which transactions are |
| | purged if queued. |
+------------------+--------------------------------------------------+
| PurgImm | The number of transactions purged immediately. |
+------------------+--------------------------------------------------+
| Purged | The number of transactions purged while |
| | queueing. |
+------------------+--------------------------------------------------+
| AtLimit | The number of times at the purge limit. |
+------------------+--------------------------------------------------+
| PurgeAct | Specifies the action that CICS takes for a |
| | request that starts a transaction when its |
| | associated TRANCLASS has reached the purge |
| | threshold. |
| | |
| | Possible values are: |
| | |
| | ABEND - CICS starts the requested |
| | transaction, and then abends it |
| | with AKCC. This is the default. |
| | |
| | DISCARD - CICS discards the request. |
| | The requested transaction is not |
| | started. This action is available |
| | at CICS TS 6.2 and higher. |
| | |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invoked the CTRANS command to display the |
| | transactions defined with the select class. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CTCLASS command security


CTDATA

CTDATA Command

The CTDATA command displays information about transient data


set activity.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTDATA | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Name,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Name | The destination identification defined in the |
| | DCT. |
+------------------+--------------------------------------------------+
| Type | The destination type. |
| | Possible values are: |
| | REMOTE Remote destination |
| | EXTRA Extrapartition destination |
| | INTRAPAR Intrapartition destination |
| | INDIRECT Indirect destination |
+------------------+--------------------------------------------------+
| INDR | The destination ID for entries with a |
| | destination type of INDIRECT. |
+------------------+--------------------------------------------------+
| Count | The number of requests made to the entry. |
+------------------+--------------------------------------------------+
| QCount | The number of entries in the destination queue. |
+------------------+--------------------------------------------------+
| Tran | The transaction ID to be started when the |
| | trigger level is reached. |
+------------------+--------------------------------------------------+
| TrigLv | The trigger level value. |
+------------------+--------------------------------------------------+
| TrigStat | The trigger status. |
| | Possible values are: |
| | NONE |
| | QUEUING |
| | TRIGGER |
| | EXCEEDED |
+------------------+--------------------------------------------------+
| SysID | The system ID for entries with a destination |
| | type of REMOTE. |
+------------------+--------------------------------------------------+
| Status1 | The status. |
| | Possible values are: |
| | ENABLED |
| | DISABLING |
| | DISABLED |
+------------------+--------------------------------------------------+
| Status2 | The status. |
| | Possible values are: |
| | OPEN |
| | OPENING |
| | CLOSED |
| | CLOSING |
+------------------+--------------------------------------------------+
| Disp | The data set disposition. |
| | Possible values are: |
| | MOD |
| | SHR |
| | OLD |
+------------------+--------------------------------------------------+
| Recovery | The recovery status. |
| | Possible values are: |
| | blank (non intrapartition queues) |
| | NO |
| | PHYSICAL |
| | LOGICAL |
| | Only valid for intrapartition queues. |
+------------------+--------------------------------------------------+
| Reads | The number of reads. |
+------------------+--------------------------------------------------+
| Writes | The number of writes. |
+------------------+--------------------------------------------------+
| Deletes | The number of deletes. |
+------------------+--------------------------------------------------+
| Trigs | The number of times that the queue has been |
| | triggered. |
| | Only valid for intrapartition queues. |
+------------------+--------------------------------------------------+
| CIs | The number of control intervals currently |
| | in use. |
| | Only valid for intrapartition queues. |
+------------------+--------------------------------------------------+
| PeakCIs | The peak number of control intervals in use. |
| | Only valid for intrapartition queues. |
+------------------+--------------------------------------------------+
| Remote | The remote queue ID. |
+------------------+--------------------------------------------------+
| JobUser | Specifies a userid that a JCL job runs under |
| | when it is submitted to the internal reader |
| | (INTRDR) and its JCL includes a JOB card |
| | but no USER parameter. |
| | |
| | If "JobUser" is not defined, the default |
| | is the CICS region userid. |
| | |
| | Only valid for extrapartition queues. |
+------------------+--------------------------------------------------+
| DFHDCTDS | The address of the DFHDCTDS control block. |
+------------------+--------------------------------------------------+
| DDname | The ddname assigned to queue. |
+------------------+--------------------------------------------------+
| Dataset-Name | The name of data set allocated to ddname. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Close | Issue a close request for the selected queue. |
+------------------+--------------------------------------------------+
| DISable | Issue a disable request for the selected queue. |
+------------------+--------------------------------------------------+
| ENAble | Issue an enable request for the selected queue. |
+------------------+--------------------------------------------------+
| Open | Issue an open request for the selected queue. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Browse | Invokes the OUTPUT command for the selected |
| | DDname. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
Security Requirements

For security requirements, use the link: CTDATA command security


CTDSTATS

CTDSTATS Command

The CTDSTATS command displays statistics for the CICS transient


data intrapartition data set.

Similar information is available via the CICS Transient Data


Report that can be obtained via the following CICS command:

EXEC CICS COLLECT STATISTICS TDQUEUE

Command Syntax

+------------------+--------------------------------------------------+
| CTDSTATS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Status | The OPEN/CLOSED status of the intrapartition |
| | data set. |
+------------------+--------------------------------------------------+
| Full | The intrapartition data set full status. |
+------------------+--------------------------------------------------+
| DDname | The DDname for the intrapartition data set. |
+------------------+--------------------------------------------------+
| Dsn | The intrapartition data set name. |
+------------------+--------------------------------------------------+

Data Fields

Control Intervals
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| CI size | The size of the control interval. |
+------------------+--------------------------------------------------+
| CI count | The current number of control intervals active |
| | within the intrapartition data set. |
+------------------+--------------------------------------------------+
| CIs used - pct | The percentage of control intervals in use. |
+------------------+--------------------------------------------------+
| CIs used - now | The current number of control intervals in use. |
+------------------+--------------------------------------------------+
| CIs used - peak | The peak number of control intervals |
| | concurrently active. |
+------------------+--------------------------------------------------+

Requests
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Reads (GETs) | The number of GETs or times that a CI has been |
| | read from disk. |
+------------------+--------------------------------------------------+
| Writes (PUTs) | The number of PUTs or times data has been |
| | written to the intrapartition transient data set.|
+------------------+--------------------------------------------------+
| Formatting | The number of times that a new CI was written |
| writes | at the end of the data set to increase the |
| | amount of available space. |
+------------------+--------------------------------------------------+
| I/O errors | The number of I/O errors that have occurred |
| | on the intrapartition data set. |
+------------------+--------------------------------------------------+
| No space | The number of times that a NOSPACE condition |
| returned | has occurred. |
+------------------+--------------------------------------------------+

Strings
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Transient data | The number of strings currently active. |
| strings | |
+------------------+--------------------------------------------------+
| Strings in use - | The total number of times a string has been |
| total | accessed. |
+------------------+--------------------------------------------------+
| Strings in use - | The number of strings currently active. |
| now | |
+------------------+--------------------------------------------------+
| Strings in use - | The peak number of strings concurrently active. |
| peak | |
+------------------+--------------------------------------------------+
| String waits - | The number of times that a task had to wait |
| total | because no strings were available. |
+------------------+--------------------------------------------------+
| String waits - | The current number of string waits. |
| now | |
+------------------+--------------------------------------------------+
| String waits - | The peak number of concurrently string waits. |
| peak | |
+------------------+--------------------------------------------------+

Buffers
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Transient data | The number of buffers. |
| buffers | |
+------------------+--------------------------------------------------+
| Buffers in use - | The number of times that intrapartition buffers |
| total | have been accessed. |
+------------------+--------------------------------------------------+
| Buffers in use - | The number of buffers currently in use. |
| now | |
+------------------+--------------------------------------------------+
| Buffers in use - | The peak number of concurrent intrapartition |
| peak | buffers accessed. |
+------------------+--------------------------------------------------+
| Buffer waits - | The number of times that a task had to wait |
| total | because all buffers were allocated to other |
| | tasks. |
+------------------+--------------------------------------------------+
| Buffer waits - | The current number of buffer waits. |
| now | |
+------------------+--------------------------------------------------+
| Buffer waits - | The peak number of concurrently buffer waits. |
| peak | |
+------------------+--------------------------------------------------+
| Valid data | The number of buffers that contain valid data. |
+------------------+--------------------------------------------------+
| Valid data - | The peak number of buffers that contained |
| peak | valid data. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CTEMPSTG

CTEMPSTG Command

The CTEMPSTG command displays CICS temporary storage statistics


for main and auxiliary storage.

Command Syntax

+------------------+--------------------------------------------------+
| CTEMPSTG | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+

Data Fields

Statistics
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| PUTS Aux | The number of write requests to auxiliary |
| | temporary storage. |
+------------------+--------------------------------------------------+
| PUTS Main | The number of write requests to main temporary |
| | storage. |
+------------------+--------------------------------------------------+
| PUT | The number of PUT requests. |
+------------------+--------------------------------------------------+
| PUTQ | The number of PUTQ requests. |
+------------------+--------------------------------------------------+
| GETS Aux | The number of get requests from auxiliary |
| | temporary storage. |
+------------------+--------------------------------------------------+
| GETS Main | The number of get requests from main temporary |
| | storage. |
+------------------+--------------------------------------------------+
| TSMain Lim | The limit for temporary storage main. |
+------------------+--------------------------------------------------+
Control Intervals
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Total | The total number of control intervals within the |
| | temporary storage auxiliary data set. |
+------------------+--------------------------------------------------+
| Bytes/CI | The number of bytes per control interval. |
+------------------+--------------------------------------------------+
| Available/CI | The number of available bytes per control |
| | interval. |
+------------------+--------------------------------------------------+
| Segments/CI | The number of segments per control interval. |
+------------------+--------------------------------------------------+

Segments
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Total | The total number of segments. |
+------------------+--------------------------------------------------+
| Free | The number of free segments. |
+------------------+--------------------------------------------------+
| Pct Used | The percentage of auxiliary temporary storage |
| | used. |
+------------------+--------------------------------------------------+
| Bytes/Seg | The number of bytes per segment. |
+------------------+--------------------------------------------------+

Exceptions
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Suspensions | The number of times that requests have been |
| | suspended due to the inability to satisfy a |
| | storage request. |
+------------------+--------------------------------------------------+
| Compressions | The number of times that a control interval |
| | within the auxiliary data set was compressed. |
+------------------+--------------------------------------------------+
| I/O Errors | The number of errors against the auxiliary |
| | storage data set. |
+------------------+--------------------------------------------------+
| PUTS]CISIZE | The number of PUTs with a length greater than |
| | the defined control interval size. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Buffers | The current number of auxiliary storage buffers. |
+------------------+--------------------------------------------------+
| Strings | The current number of auxiliary storage strings. |
+------------------+--------------------------------------------------+
| TSMain Storage | The current amount of MAIN temporary storage |
| | in use. |
| | |
| | The maximum amount of MAIN temporary storage |
| | that was used. |
+------------------+--------------------------------------------------+
| Queues | The current number of temporary storage queues. |
| | The maximum number of temporary storage queues |
| | concurrently allocated. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Buffer Waits | The current, maximum, and total number of buffer |
| | waits that have occurred while processing |
| | auxiliary storage data set requests. |
| | |
| | A buffer wait occurs if the required CI is in a |
| | locked buffer, therefore unavailable, even if |
| | other buffers are available. |
+------------------+--------------------------------------------------+
| String Waits | The current, maximum, and total number of string |
| | waits that have occurred while processing |
| | auxiliary storage data set requests. |
| | |
| | If this value is not zero, you should consider |
| | increasing the number of strings. |
+------------------+--------------------------------------------------+
| Write Buffers | The current and maximum number of write buffers |
| | for auxiliary storage. |
| | |
| | Writes forced by the buffer to accommodate |
| | another CI can cause high I/O activity. This |
| | can be minimized by increasing the buffer |
| | allocation using the System Initialization |
| | Table parameter TS=(b,s), where b is the |
| | number of buffers and s is the number of |
| | strings. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Items in Longest | The peak number of items in any one queue. |
| Queue | |
+------------------+--------------------------------------------------+
| Longest Aux | The size, in bytes, of the longest record |
| Record Length | written to the temporary storage auxiliary data |
| | set. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

Problem Determination

Temporary storage allows the user to either write data out


to main storage or to hold records out in the VSAM data set
DHFTEMP. If records are written out to main storage, then
the records should be read and purged by the next transaction.
Data written out to the VSAM AUX storage data set is held for
a long period of time before being read and purged.

Problems occur when records written out to main storage are


not quickly read and purged. This causes storage fragmentation
or even SOS (Short On Storage) conditions. However, the
opposite is true for AUX temporary storage. If records are
written, quickly read and purged, then this increases I/O
overhead, the occurrence of control interval compressions,
and increased processing overhead.

Data written to the VSAM AUX data set is placed into fixed
segments in freed segments mixed with used segments. When
CICS needs to reuse the CI, a compression occurs that moves
the used segments to the front of the CI and the unused to
the back. This delays transaction processing. If the CI is
too small, then compressions occur frequently. The CI should
be large enough to hold many records.

If many records are written to a queue, then the SIT parameter


TSMGSET must be made larger than the default of 4. For each
record in a queue, a pointer entry in the TSGID table is created.
If many records are written, then many TSGIDs are needed. The
first is called the parent and all others are called children.
Statistics are kept in the parent TSGID. Whenever a TSGID fills,
another TSGID is created. This causes erratic response times
and an increase in paging as the TSGIDs mostly are not contiguous.

If the number of CIs available becomes small, then this can


lead to transactions being suspended because there is no more
room in the AUX data set.

Queues written to DFHTEMP or auxiliary storage should be used


for tasks that require that the queues have a long life time.
If the lifetime of a queue is short, then two problems arise.

1. If queues are written to DFHTEMP and then immediately


read and purged, an I/O bottleneck occurs. This can
cause sporadic response times.

2. If the transactions that write to DFHTEMP are short in


lifetime and frequently used, then this could add to
the CPU utilization for the CICS region due to the
excess processing that occurs.

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CTERMS

CTERMS Command

The CTERMS command displays a list of terminals that have


been defined or are active to CICS.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTERMS | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Term,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname that owns the resource. |
+------------------+--------------------------------------------------+
| Term | The CICS terminal name. |
+------------------+--------------------------------------------------+
| Netname | The VTAM Logical Unit name (LU). |
+------------------+--------------------------------------------------+
| Type | The terminal access method. |
| | Possible values are: |
| | |
| | BSAM |
| | BTAM |
| | CONS |
| | GAM |
| | ISMM |
| | MRO |
| | SKEL |
| | TCAM |
| | TMSN |
| | VTAM |
+------------------+--------------------------------------------------+
| Ins | The current service status. |
| | Possible values are: |
| | |
| | INS - In service |
| | OUT - Out of service |
| | blank - Not applicable |
+------------------+--------------------------------------------------+
| Acq | The current terminal status. (VTAM only) |
| | Possible values are: |
| | |
| | ACQ - Acquired |
| | REL - Released |
| | blank - Not applicable |
+------------------+--------------------------------------------------+
| ATI | Indicates whether the terminal is available for |
| | use by transactions that are automatically |
| | initiated from within CICS. |
| | Possible values are: |
| | |
| | ATI - The terminal is available for use |
| | NOATI - The terminal is not available for use |
+------------------+--------------------------------------------------+
| TTI | Indicates whether the terminal can be used by |
| | transactions that are initiated from this |
| | terminal. |
| | Possible values are: |
| | |
| | TTI - The terminal can be used by |
| | transactions |
| | NOTTI - The terminal cannot be used by |
| | transactions |
+------------------+--------------------------------------------------+
| Create | Indicates whether the terminal can be acquired |
| | automatically by ATI transaction. (VTAM only) |
| | Possible values are: |
| | |
| | CREATE - If the terminal is not in session,|
| | CICS will acquire it if needed to |
| | satisfy an ATI request. |
| | NOCREATE - If the terminal is not in session,|
| | CICS will not acquire it to |
| | satisfy an ATI request. |
| | blank - Not applicable |
+------------------+--------------------------------------------------+
| Tran | The current transaction ID. |
+------------------+--------------------------------------------------+
| Task# | The current transaction number. |
+------------------+--------------------------------------------------+
| Next | The name of the next transaction ID, if it was |
| | specified. |
+------------------+--------------------------------------------------+
| Userid | The external security userid. |
+------------------+--------------------------------------------------+
| Console | The console name of type = CONS. |
+------------------+--------------------------------------------------+
| ConsID | The console ID. |
+------------------+--------------------------------------------------+
| Pri | The terminal priority. |
+------------------+--------------------------------------------------+
| Count | The number of transactions executed. |
+------------------+--------------------------------------------------+
| ICount | The number of invalid transactions entered. |
+------------------+--------------------------------------------------+
| Input | The number of input requests. |
+------------------+--------------------------------------------------+
| Output | The number of output requests. |
+------------------+--------------------------------------------------+
| Errors | The number of terminal I/O errors. |
+------------------+--------------------------------------------------+
| Default | The default screen size. |
+------------------+--------------------------------------------------+
| Alternate | The alternate screen size. |
+------------------+--------------------------------------------------+
| Status | The terminal status. |
| | Possible values are: |
| | |
| | Skeleton Term |
| | Out Of Service |
| | Term Attended |
| | Auto Tran Init |
| | Receive Only |
| | Term Quiescing |
| | Permanent Out |
| | Read Only |
| | Dummy TCTTE |
| | Session |
+------------------+--------------------------------------------------+
| Rmte | Specifies the remote system name for terminal |
| | sessions. |
+------------------+--------------------------------------------------+
| Cid | Specifies the correlator ID for terminal |
| | sessions. |
+------------------+--------------------------------------------------+
| Commarea | The address of the current communications area, |
| | if present. |
+------------------+--------------------------------------------------+
| CommLen | The length of the current communications area, |
| | if present. |
+------------------+--------------------------------------------------+
| Alarm | Specifies ALARM if the alarm option is supported |
| | by the terminal. Otherwise blank. |
+------------------+--------------------------------------------------+
| ExtDS | Specifies EXTDS if Extended Data Streams are |
| | supported by the terminal. Otherwise blank. |
+------------------+--------------------------------------------------+
| Color | Specifies COLOR if color is supported by the |
| | terminal. Otherwise blank. |
+------------------+--------------------------------------------------+
| Hilight | Specifies HILIGHT if highlighting is supported |
| | by the terminal. Otherwise blank. |
+------------------+--------------------------------------------------+
| Uctran | Specifies UCTRAN if uppercase translation is |
| | active for the terminal. Otherwise blank. |
+------------------+--------------------------------------------------+
| Cursor | The cursor position at last input. |
+------------------+--------------------------------------------------+
| AIDKey | The AID key of the last input request. |
+------------------+--------------------------------------------------+
| DFHTCTTE | The address of the DFHTCTTE control block. |
+------------------+--------------------------------------------------+
| UserArea | The address of the TCTUA control block. |
+------------------+--------------------------------------------------+
| UserLen | The length of userarea. |
+------------------+--------------------------------------------------+
| Mode | The name of the connection that owns this mode |
| | group entry. Blank if not part of a mode group. |
+------------------+--------------------------------------------------+
| TT | The terminal type code |
+------------------+--------------------------------------------------+
| TermType | The terminal type |
| | Possible values are: |
| | |
| | blank - unknown |
| | 7770 - 7770 |
| | SYSTEM7 - System 7 |
| | CONSOLE - Console |
| | SEQDISK - Sequential disk |
| | MAGTAPE - Magnetic tape |
| | LINEPTR - Card reader / Line printer |
| | SPOOLSYS - Spooling system printer |
| | SPOOLRDR - Spooling internal reader |
| | HARDCOPY - Hard copy terminals |
| | MOD33/35 - Model 33/35 TWX |
| | TELETYPE - Teletypewriter |
| | 1050 - 1050 |
| | 2740 - 2740 |
| | 2741C - 2741 correspondence |
| | 2741E - 2741 EDCDIC |
| | VIDEO - VIDEO terminals |
| | 2260LOC - 2260 local |
| | 2260RMT - 2260 remote |
| | 1053 - 1053 |
| | 2265 - 3365 |
| | TCAM - TCAM |
| | BISYNCH - BISYNCH |
| | 2770 - 2770 |
| | 2780 - 2780 |
| | 3780 - 3780 |
| | 2980 - 2980 |
| | 3735 - 3735 |
| | 3740 - 3740 |
| | 3600 - 3600 BISYNCH |
| | 3277 - 3277 remote BTAM and Remote/Local |
| | VTAM |
| | 3275 - 3275 remote |
| | 3270P - BTAM 3284 remote and |
| | VTAM 3270p all |
| | B3286 - BTAM B3286 remote |
| | 3277 - 3277 local BTAM |
| | 3284 - BTAM 3284 local |
| | 3286 - BTAM 3286 local |
| | PROGDEV - BISYNCH - programmable device |
| | SYSTEM3 - System/3 |
| | SYS370 - System/370 |
| | PROGDEV - Programmable device |
| | PROGDEV - Programmable device |
| | SDLC - SDLC device class |
| | 3601 - 3601 |
| | 3614 - 3614 |
| | 3790 - 3790 |
| | 3790USER - 3790 USERPROGRAM |
| | 3790SCSP - 3790 SCS printer |
| | 3650PIPE - 3650 PIPELINE |
| | 3653HOST - 3653 HOST CONVERSATIONAL |
| | 3650ATT - 3650 ATTACHED 3270 H. C. |
| | 3650USER - 3650 USERPROGRAM |
| | CONTLU - CONTENTION logical unit |
| | INTERLU - INTERACTIVE logical unit |
| | BATCHLU - BATCH logical unit |
| | LUTYPE6 - LUTYPE 6 |
| | LUTYPE4 - LUTYPE 4 |
| | SYSENTRY - System entry |
| | IRC - IRC Conversation |
| | LUCGROUP - LUC mode GROUP ENTRY |
| | LUCSESS - LUC SESSION |
| | 3750 - 1750/3750 SWITCHING system |
| | SKELETON - Skeleton entry |
| | EVANCONS - Evanescent consoles |
| | EVANTERM - Evanescent terms |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Acquire | Acquire the selected terminal. |
+------------------+--------------------------------------------------+
| CAIds | Cancel any AIDs queuing for the selected |
| | terminal. |
+------------------+--------------------------------------------------+
| CReate | If the terminal is not in session, CICS will |
| | acquire it if needed to satisfy an ATI request. |
+------------------+--------------------------------------------------+
| Force | Force purge any transaction running on the |
| | selected terminal. |
| | |
| | Method: |
| | |
| | CEMT SET TERM(termid) FORCE |
| | |
| | *** Data integrity is NOT guaranteed |
+------------------+--------------------------------------------------+
| Inservic | Make the terminal available for use. If it is a |
| | VTAM terminal, then the terminal can be acquired.|
+------------------+--------------------------------------------------+
| Kill | Kill any transaction running on the selected |
| | terminal. |
| | |
| | Method: |
| | |
| | CEMT SET TERM(termid) KILL |
| | |
| | *** System and data integrity is NOT guaranteed |
+------------------+--------------------------------------------------+
| NOCreate | If the terminal is not in session, CICS will not |
| | acquire it to satisfy an ATI request. |
+------------------+--------------------------------------------------+
| Outserv | Make the terminal not available for use. |
+------------------+--------------------------------------------------+
| Purge | Purge any transaction running on the selected |
| | terminal only if system and data integrity can |
| | be maintained. |
| | |
| | Method: |
| | |
| | CEMT SET TERM(termid) PURGE |
| | |
+------------------+--------------------------------------------------+
| Release | Release the terminal from CICS. Currently |
| | running transactions are allowed to finish. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CTERMS command security


CTGLIST

CTGLIST Command

The CTGLIST command displays a list of active CICS Transaction Gateways.

This command only supports CICS Transaction Gateways that are deployed
in a remote mode topology. The information displayed will only be
available for CICS Transaction Gateway daemons.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Suggested Screen Size

This command is best viewed on a display with a screen size that is


greater than 80 columns.
Follow this link for more information: Dynamic screen sizes

The data contained in the display fields can be large.


The provided field formats have been ordered and sized to display the
information based on typical data. You are encouraged to create new
formats or alter the supplied field formats to meet your needs.

Command Syntax

+------------------+--------------------------------------------------+
| CTGLIST | [ SYStem | XSYStem | NOXSYStem ] |
| | |
| | [ TOTal | INTerval ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| SYStem | All active CICS Transaction Gateway address |
| | spaces on the current system will be displayed. |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| TOTal | Fields that support total and interval values |
| | will display values calculated since the CTG was |
| | successfully initalized. |
+------------------+--------------------------------------------------+
| INTerval | Fields that support total and interval values |
| | will display values calculated for the current |
| | statistics interval. This interval is defined by |
| | the StatInt parameter in the Gateway INI file. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID (ASID) of the current |
| | address space. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier (Jobid) of the current |
| | address space. This is a concatenation of |
| | the current job type and job number. |
| | |
| | Example: TSU03654 |
+------------------+--------------------------------------------------+
| PID | The current process ID (PID) of a JVM with an |
| | installed JVM data collector. |
| | |
| | The PID value is used to specify the data to be |
| | displayed in JOB mode. |
| | |
| | Possible values are: |
| | |
| | * - Indicates that all PIDs for the |
| | current address space with an |
| | installed data collector will be |
| | displayed. |
| | |
| | xxxxxxxx - Indicates that only the specified |
| | PID for the current address space |
| | will be evaluated or displayed. |
| | |
| | The PID can be set using the following command: |
| | |
| | SET PID * | xxxxxxxx |
| | |
| | When the current target address space is |
| | changed, the PID value will be set to "*". |
| | |
+------------------+--------------------------------------------------+
| Mode | The current display mode. |
| | |
| | Possible values are: |
| | |
| | JOB - Data will be displayed for the |
| | current address space. |
| | |
| | If PID = *, all PIDs with an |
| | installed data collector will be |
| | displayed. |
| | |
| | If PID [] *, data from an |
| | installed data collector for the |
| | PID will be displayed. |
| | |
| | SYSTEM - All jobs on the current system. |
| | |
| | All PIDs in all address spaces |
| | with an installed data collector |
| | will be displayed. |
| | |
| | XSYSTEM - All jobs on all systems. |
| | |
| | All PIDs in all address spaces |
| | with an installed data collector |
| | will be displayed. |
| | |
| | All connected cross-system LPARs |
| | or systems will be included. |
| | |
+------------------+--------------------------------------------------+
| Options | Lists the current effective options. These |
| | options can be the original initial defaults, |
| | defaults overridden with the OPTIONS subcommand, |
| | or options specified on the CTGLIST command. |
| | |
| | These fields can be toggled by selecting the |
| | field. Any overtyped input is ignored. |
| | |
| | Possible values are: |
| | |
| | TOTAL Fields that support total and |
| | interval values will display |
| | values calculated since the CTG |
| | was successfully initialized. |
| | |
| | INTERVAL Fields that support total and |
| | interval values will display |
| | values calculated for the |
| | current statistics interval. |
| | This interval is defined by the |
| | StatInt parameter in the Gateway |
| | INI file. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,ServerName,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The name of the job executing the CICS |
| | Transaction Gateway. |
| | |
| | This field will be highlighted if it matches |
| | the current target jobname. |
+------------------+--------------------------------------------------+
| ASID | The hexadecimal address space ID executing |
| | the CICS Transaction Gateway. |
| | |
| | This field will be highlighted if it matches |
| | the current target ASID. |
+------------------+--------------------------------------------------+
| MON | Indicates whether the CTG has been configured |
| | with a SYSVIEW data collector agent. |
| | |
| | Possible values are: |
| | |
| | MON The JVM has been configured with a |
| | SYSVIEW data collector, and the |
| | subsystem ID and the architecture |
| | level for the data collector agent |
| | matches the SYSVIEW session. |
| | |
| | MONX The JVM has been configured with a |
| | SYSVIEW data collector, but |
| | either the subsystem ID or the |
| | architecture level for the data |
| | collector agent does not match the |
| | SYSVIEW session. |
| | |
| | blank The JVM has not been configured with |
| | a SYSVIEW data collector agent. |
| | |
| | The JVMDMON display shows a list of all active |
| | JVM data collector agents. |
+------------------+--------------------------------------------------+
| Status | The status of the CTG. |
| | |
| | Possible values are: |
| | |
| | STARTING The CTG is starting up. |
| | |
| | RUNNING The CTG is running. |
| | |
| | STOPPING The CTG is in the process of |
| | shutting down. |
| | |
| | Statistics ID: GD_CSTATUS |
+------------------+--------------------------------------------------+
| Requests | The number of API calls (ECI, ESI) and XA |
| | requests that have been processed. Successful |
| | and failed requests are included. Administrative |
| | requests and handshakes are excluded. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: GD_LALLREQ/GD_IALLREQ |
+------------------+--------------------------------------------------+
| RespTime | The average time for the CTG to respond to API |
| | (ECI, ESI) and XA (two-phase commit) requests |
| | from remote clients. Successful and failed |
| | requests are included. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: GD_LAVRESP/GD_IAVRESP |
+------------------+--------------------------------------------------+
| IOTime | The average time for the CTG to respond to API |
| | (ECI, ESI) and XA requests from remote clients |
| | including network I/O time. Successful and |
| | failed requests are included. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: GD_LAVRESPIO/GD_IAVRESPIO |
+------------------+--------------------------------------------------+
| Fails | The total number of failures across the CTG. |
| | |
| | This field is the sum of the following fields |
| | on this display: |
| | |
| | CMTimeOut |
| | WTTimeOut |
| | CommFail |
| | ConnLost |
| | TimeOut |
| | ConnFail |
| | IPICFail |
| | EXCIFail |
| | SYNCFail |
| | |
| | This field supports total and interval values. |
+------------------+--------------------------------------------------+
| MonCtg | Displays the state of the JVM agent monitoring |
| | the CTG. |
| | |
| | Possible values are: |
| | |
| | NOTCONFIG - The CTG was configured to be |
| | monitored by the JVM agent, |
| | but either the monctg option |
| | was not passed to the JVM |
| | agent or the monctg option |
| | was specified as disabled. |
| | General JVM monitoring is |
| | still available. Any fields |
| | on this display with a |
| | Statistics ID documented, |
| | will be blank. |
| | |
| | INITIALIZING - CTG monitoring is starting. |
| | CTG statistics are not |
| | available until the CTG |
| | initializes. |
| | |
| | INITIALIZED - CTG monitoring is fully |
| | initialized. |
| | |
| | blank - The CTG was not configured |
| | to be monitored by the JVM |
| | agent or the CTG was |
| | configured to be monitored |
| | by another instance of |
| | SYSVIEW. The latter is |
| | indicated by the MONX value |
| | in the MON field. |
+------------------+--------------------------------------------------+
| LUWCur | The current number of inflight extended LUW |
| | transactions. These transactions might or might |
| | not be active in a CICS server. However, they |
| | always represent one mirror transaction, which |
| | might be in a suspended state. |
| | |
| | Statistics ID: GD_CLUWTXN |
+------------------+--------------------------------------------------+
| LUWCmt | The number of extended LUW-based transactions |
| | that were committed. This field displays |
| | information about 1-phase commit transactions. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: GD_LLUWTXNC/GD_ILUWTXNC |
+------------------+--------------------------------------------------+
| LUWRoll | The number of extended LUW-based transactions |
| | that were rolled back. This field displays |
| | information about 1-phase commit transactions. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: GD_LLUWTXNR/GD_ILUWTXNR |
+------------------+--------------------------------------------------+
| SyncCur | The current number of inflight SYNCONRETURN |
| | transactions. |
| | |
| | Statistics ID: GD_CSYNCTXN |
+------------------+--------------------------------------------------+
| SyncSucc | The number of successful SYNCONRETURN |
| | transactions. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: GD_LSYNCTXN/GD_ISYNCTXN |
+------------------+--------------------------------------------------+
| SYNCFail | The number of failed SYNCONRETURN transactions. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: GD_LSYNCFAIL/GD_ISYNCFAIL |
+------------------+--------------------------------------------------+
| XAReq | The number of XA requests processed for XA |
| | transactions. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: GD_LXAREQ/GD_IXAREQ |
+------------------+--------------------------------------------------+
| XACur | The current number of inflight XA transactions. |
| | These transactions might or might not be active |
| | in CICS. However, they represent one mirror |
| | transaction, which might be in a suspended |
| | state. |
| | |
| | Statistics ID: GD_CXATXN |
+------------------+--------------------------------------------------+
| XAHWM | The high water mark of XA transactions that have |
| | been in flight at the same time. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: GD_LXATXNHI/GD_IXATXNHI |
+------------------+--------------------------------------------------+
| XACmt | The number of XA commit requests that were |
| | successfully processed. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: GD_LXATXNC/GD_IXATXNC |
+------------------+--------------------------------------------------+
| XARoll | The number of XA rollback requests that were |
| | successfully processed. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: GD_LXATXNR/GD_IXATXNR |
+------------------+--------------------------------------------------+
| XAComp | The number of completed XA transactions that |
| | were started by another gateway daemon in the |
| | group. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: GD_LXACOMP/GD_IXACOMP |
+------------------+--------------------------------------------------+
| ReqExit | The number of times the CICS request exit was |
| | called. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: GD_LHAEXIT/GD_IHAEXIT |
+------------------+--------------------------------------------------+
| ReqLen | The average amount of request data received from |
| | client applications. |
| | |
| | This field supports total and interval values. |
+------------------+--------------------------------------------------+
| RespLen | The average amount of response data sent to |
| | client applications. |
| | |
| | This field supports total and interval values. |
+------------------+--------------------------------------------------+
| ReqLenT | The total amount of request data received from |
| | client applications. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: GD_LREQDATA/GD_IREQDATA |
+------------------+--------------------------------------------------+
| RespLenT | The total amount of response data sent to client |
| | applications. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: GD_LRESPDATA/GD_IRESPDATA |
+------------------+--------------------------------------------------+
| CSReq | The number of requests to CICS servers that |
| | have been processed. This number includes |
| | successful and failed requests. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: CS_LALLREQ/CS_IALLREQ |
+------------------+--------------------------------------------------+
| CSWait | The number of requets currently waiting for a |
| | response from a CICS server. |
| | |
| | Statistics ID: CS_CWAITING |
+------------------+--------------------------------------------------+
| CSResT | The average time taken for connected CICS |
| | servers to respond to the Gateway daemon. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: CS_LAVRESP/CS_IAVRESP |
+------------------+--------------------------------------------------+
| CSReqL | The amount of request data sent to connected |
| | CICS servers. This includes both application and |
| | CICS protocol data. For CICS servers using the |
| | IPIC protocol, this value includes COMMAREA and |
| | CICS headers. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: CS_LREQDATA/CS_IREQDATA |
+------------------+--------------------------------------------------+
| CSResL | The amount of response data received from |
| | connected CICS servers. This includes both |
| | application and CICS protocol data. For CICS |
| | servers using the IPIC protocol, this value |
| | includes COMMAREA and CICS headers. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: CS_LRESPDATA/CS_IRESPDATA |
+------------------+--------------------------------------------------+
| CSNum | The number of CICS servers to which requests |
| | have been sent. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: CS_LCOUNT/CS_ICOUNT |
+------------------+--------------------------------------------------+
| CSConf | The number of CICS servers defined in the |
| | configuration file. |
| | |
| | Statistics ID: CS_SCOUNT |
+------------------+--------------------------------------------------+
| IPICCur | The number of IPIC sessions in use with CICS |
| | servers. |
| | |
| | Statistics ID: CS_CSESSCURR |
+------------------+--------------------------------------------------+
| IPICMax | The number of IPIC sessions negotiated with CICS |
| | servers. |
| | |
| | Statistics ID: CS_CSESSMAX |
+------------------+--------------------------------------------------+
| IPICFail | The number of failures on IPIC sessions to CICS |
| | servers. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: CS_LSESSFAIL/CS_ISESSFAIL |
+------------------+--------------------------------------------------+
| EXCIAlloc | The current number of allocated EXCI pipes |
| | across all CICS servers. |
| | |
| | Statistics ID: CS_CALLOC |
+------------------+--------------------------------------------------+
| EXCIMax | The maximum EXCI pipe allocation for each MVS |
| | address space. This value is equivalent to the |
| | CICS subsystem initialization parameter |
| | LOGONLIM. |
| | |
| | Statistics ID: CS_SLOGONLIM |
+------------------+--------------------------------------------------+
| EXCIPct | The percentage of the maximum number of |
| | EXCI pipes currently allocated. |
+------------------+--------------------------------------------------+
| EXCIPipe | The NETNAME of the specific pipe used for EXCI |
| | calls or blanks if generic pipes are being used. |
| | |
| | The NETNAME is defined by the environment |
| | variable DFHJVPIPE. |
| | |
| | Statistics ID: CS_SNETNAME |
+------------------+--------------------------------------------------+
| EXCIFail | The number of times the Gateway daemon has tried |
| | and failed to allocate a pipe to a CICS server. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: CS_LALLOCFAIL/CS_IALLOCFAIL |
+------------------+--------------------------------------------------+
| CommFail | The number of times communication with a CICS |
| | server has failed after a connection has already |
| | been established or when there has been a |
| | failure with the link during communication with |
| | the server. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: CS_LCOMMSFAIL/CS_ICOMMSFAIL |
+------------------+--------------------------------------------------+
| ConnFail | The number of times an attempt to connect to a |
| | CICS server has failed. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: CS_LCONNFAIL/CS_ICONNFAIL |
+------------------+--------------------------------------------------+
| ConnLost | The number of times an established connection |
| | with a CICS server has been lost. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: CS_LLOSTCONN/CS_ILOSTCONN |
+------------------+--------------------------------------------------+
| TimeOut | The number of times a connection to a CICS |
| | server has timed out due to being idle. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: CS_LIDLETIMEOUT/CS_IIDLETIMEOUT |
+------------------+--------------------------------------------------+
| Realloc | The number of times that a worker thread has to |
| | deallocate its existing pipe and reallocate a |
| | new pipe because the existing pipe points to a |
| | different CICS server from that required by the |
| | request. This field applies only when the |
| | environment variable CTG_PIPE_REUSE is set to |
| | ONE. This field does not include cases where the |
| | pipe for the worker thread was deallocated and |
| | reallocated because the CICS server was not |
| | available are excluded. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: CS_LREALLOC/CS_IREALLOC |
+------------------+--------------------------------------------------+
| LSReq | The number of requests to logical CICS servers |
| | that have been processed. This number includes |
| | successful and failed requests. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: LS_LALLREQ/LS_IALLREQ |
+------------------+--------------------------------------------------+
| LSNum | The number of logical CICS servers to which |
| | requests have been sent. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: LS_LCOUNT/LS_ICOUNT |
+------------------+--------------------------------------------------+
| LServ | The number of logical CICS server defined in the |
| | configuration file. |
| | |
| | Statistics ID: LS_SCOUNT |
+------------------+--------------------------------------------------+
| WSReq | The current number of inflight web service |
| | requests. These requests might or might not be |
| | active in CICS. However, they represent one |
| | mirror transaction, which might be in a |
| | suspended state. |
| | |
| | Statistics ID: WS_CREQ |
+------------------+--------------------------------------------------+
| WSWait | The current number of web service requests |
| | waiting for a worker thread to become available. |
| | |
| | Statistics ID: WS_CWAITING |
+------------------+--------------------------------------------------+
| WSReqT | The number of web service requests that have |
| | been processed. This value includes successful |
| | and failed requests. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: WS_LALLREQ/WS_IALLREQ |
+------------------+--------------------------------------------------+
| WSReqHWM | The high water mark of concurrent web service |
| | requests that have been in flight at the same |
| | time. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: WS_LREQHI/WS_IREQHI |
+------------------+--------------------------------------------------+
| WSResT | The average time for web services to respond |
| | to requests from remote clients. This value |
| | includes successful and failed requests. This |
| | value is inclusive of the CICS response time. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: WS_LAVRESP/WS_IAVRESP |
+------------------+--------------------------------------------------+
| WSReqL | The amount of application request data received |
| | from clients of all web services. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: WS_LREQDATA/WS_IREQDATA |
+------------------+--------------------------------------------------+
| WSResL | The amount of application response data returned |
| | to clients of all web services. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: WS_LRESPDATA/WS_IRESPDATA |
+------------------+--------------------------------------------------+
| WSConf | The number of web services defined in the |
| | configuration file. |
| | |
| | Statistics ID: WS_SCOUNT |
+------------------+--------------------------------------------------+
| WSMax | The maximum number of HTTP client threads for |
| | processing web service requests. |
| | |
| | Statistics ID: WS_SMAXHTTP |
+------------------+--------------------------------------------------+
| WTAlloc | The current number of worker threads that are |
| | processing requests. |
| | |
| | Statistics ID: WT_CALLOC |
+------------------+--------------------------------------------------+
| WTCurr | The current number of worker threads created. |
| | |
| | Statistics ID: WT_CCURR |
+------------------+--------------------------------------------------+
| WTMax | The maximum number of parallel requests |
| | maxworker that the Gateway daemon can process. |
| | |
| | Statistics ID: WT_SMAX |
+------------------+--------------------------------------------------+
| WTHWM | The high water mark of worker threads |
| | concurrently in use for the current interval. |
| | |
| | Statistics ID: WT_IALLOCHI |
+------------------+--------------------------------------------------+
| WTInit | The initial number of worker threads initworker |
| | created by the Gateway daemon. |
| | |
| | Statistics ID: WT_SINIT |
+------------------+--------------------------------------------------+
| WTTimeOut | The number of times a worker thread could not be |
| | allocated within the defined workertimeout |
| | length of time. The workertimeout value is set |
| | in the CTG INI file. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: WT_LTIMEOUTS/WT_ITIMEOUTS |
+------------------+--------------------------------------------------+
| TCPAddr | The address or host name to which the TCP |
| | protocol handler is bound. |
| | |
| | Statistics ID: PH_SBINDTCP |
+------------------+--------------------------------------------------+
| TCPPort | The TCP protocol handler port number. |
| | |
| | Statistics ID: PH_SPORTTCP |
+------------------+--------------------------------------------------+
| SSLAddr | The address or host name to which the SSL |
| | protocol handler is bound. |
| | |
| | Statistics ID: PH_SBINDSSL |
+------------------+--------------------------------------------------+
| SSLPort | The SSL protocol handler port number. |
| | |
| | Statistics ID: PH_SPORTSSL |
+------------------+--------------------------------------------------+
| HTTPAddr | The address or host name to which the HTTP |
| | protocol handler is bound. |
| | |
| | Statistics ID: PH_SBINDHTTP |
+------------------+--------------------------------------------------+
| HTTPPort | The HTTP protocol handler port. |
| | |
| | Statistics ID: PH_SPORTHTTP |
+------------------+--------------------------------------------------+
| HTTPSAddr | The address or host name to which the HTTPS |
| | protocol handler is bound. |
| | |
| | Statistics ID: PH_SBINDHTTPS |
+------------------+--------------------------------------------------+
| HTTPSPort | The HTTPS protocol handler port number. |
| | |
| | Statistics ID: PH_SPORTHTTPS |
+------------------+--------------------------------------------------+
| HeapInit | The size of the Gateway daemon initial JVM heap. |
| | |
| | Statistics ID: SE_SHEAPINIT |
+------------------+--------------------------------------------------+
| HeapMax | The size of the Gateway daemon maximum JVM heap. |
| | |
| | Statistics ID: SE_SHEAPMAX |
+------------------+--------------------------------------------------+
| HeapGc | The Gateway daemon JVM heap size after the last |
| | garbage collection. |
| | |
| | Statistics ID: SE_CHEAPGCMIN |
+------------------+--------------------------------------------------+
| EPVTFree | The amount of available extended user private |
| | storage in the Gateway daemon address space. |
| | This amount is less than or equal to the amount |
| | of storage specified by the job REGION |
| | parameter. |
| | |
| | Statistics ID: SE_SELIM |
+------------------+--------------------------------------------------+
| EPVTAlloc | The amount of currently allocated extended user |
| | private storage in the Gateway daemon address |
| | space. |
| | |
| | Statistics ID: SE_CELOAL |
+------------------+--------------------------------------------------+
| EPVTMax | The real-time limit for used storage. If the |
| | value of SEAlloc approaches this value, the |
| | Gateway daemon is at risk of failing with a |
| | Java OutOfMemory exception. |
| | |
| | Statistics ID: SE_C31MAX |
+------------------+--------------------------------------------------+
| GC | The number of garbage collection events. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: SE_LGCCOUNT/SE_IGCCOUNT |
+------------------+--------------------------------------------------+
| GCTime | The length of time taken by the JVM for garbage |
| | collection. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: SE_LGCTIME/SE_IGCTIME |
+------------------+--------------------------------------------------+
| CnMgrs | The current number of connection manager threads |
| | allocated to clients. |
| | |
| | Statistics ID: CM_CALLOC |
+------------------+--------------------------------------------------+
| CMPct | The percentage of the maximum number of |
| | connection manager threads currently in use. |
+------------------+--------------------------------------------------+
| CMCrt | The current number of connection manager threads |
| | created. |
| | |
| | Statistics ID: CM_CCURR |
+------------------+--------------------------------------------------+
| CMWait | The current number of connection managers |
| | waiting for a worker thread to become available. |
| | |
| | Statistics ID: CM_CWAITING |
+------------------+--------------------------------------------------+
| CMAlloc | The number of allocations for connection manager |
| | threads representing the number of connections |
| | that have been established from remote clients. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: CM_LALLOC/CM_IALLOC |
+------------------+--------------------------------------------------+
| CMCrtI | The number of connection manager threads |
| | created for the current interval. |
| | |
| | Statistics ID: CM_ICREATED |
+------------------+--------------------------------------------------+
| CMTimeOut | The number of times that the Gateway daemon |
| | failed to allocate a connection manager thread |
| | within the length of time defined by the |
| | connecttimeout parameter in the Gateway INI |
| | file. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: CM_LTIMEOUTS/CM_ITIMEOUTS |
+------------------+--------------------------------------------------+
| CMHWM | The high water mark of connection manager |
| | threads concurrently allocated to client |
| | applications for the current interval. |
| | |
| | Statistics ID: CM_IALLOCHI |
+------------------+--------------------------------------------------+
| CMInit | The initial number of connection manager threads |
| | created. |
| | |
| | Statistics ID: CM_SINIT |
+------------------+--------------------------------------------------+
| CMMax | The maximum number of connection manager threads |
| | that can possibly be created and allocated. |
| | |
| | Statistics ID: CM_SMAX |
+------------------+--------------------------------------------------+
| Health | The current health of communications between |
| | CTG and CICS. |
| | |
| | This field will be 0 if all requests within the |
| | interval specified by the healthinterval |
| | parameter in the Gateway INI file fail with |
| | ECI_ERR_NO_CICS or ECI_ERR_RESOURCE_SHORTAGE. |
| | |
| | Statistics ID: GD_CHEALTH |
+------------------+--------------------------------------------------+
| Version | The CTG version. |
| | |
| | Statistics ID: GD_SVER |
+------------------+--------------------------------------------------+
| RunTime | The amount of time since the CTG successfully |
| | initialized. |
| | |
| | Statistics ID: GD_LRUNTIME |
+------------------+--------------------------------------------------+
| EODTime | The time to be designated as the logical end of |
| | day by the CTG. At the logical end of day, all |
| | interval statistics are reset according to their |
| | defined default value. |
| | |
| | Statistics ID: GD_SSTATEOD |
+------------------+--------------------------------------------------+
| IntvlLen | The duration of the statistics interval in use |
| | by the CTG. At the end of each interval, all |
| | interval statistics are reset according to their |
| | defined default value. |
| | |
| | Statistics ID: GD_SSTATINT |
+------------------+--------------------------------------------------+
| IntvlEnd | The time of the next scheduled interval |
| | statistics reset event. |
| | |
| | Statistics ID: GD_CNEXTRESET |
+------------------+--------------------------------------------------+
| IntvlCur | The age of the current interval. |
| | |
| | Statistics ID: GD_IRUNTIME |
+------------------+--------------------------------------------------+
| Applid | The APPLID of the CTG, which identifies the |
| | instance of the CTG on CICS server connections. |
| | |
| | Statistics ID: GD_SAPPLID |
+------------------+--------------------------------------------------+
| ApplidQ | The APPLID qualifier of the CTG. In combination |
| | with the APPLID, the fully qualified APPLID |
| | identifies the CTG to the CICS system to which |
| | it connects. |
| | |
| | Statistics ID: GD_SAPPLIDQ |
+------------------+--------------------------------------------------+
| HostName | The host name of the CTG. If the host name |
| | cannot be determined, this field will be set to |
| | "Unknown". |
| | |
| | Statistics ID: GD_SHOSTNAME |
+------------------+--------------------------------------------------+
| DfltSrvr | The default CICS server for the CTG. |
| | |
| | Statistics ID: GD_SDFLTSRV |
+------------------+--------------------------------------------------+
| ClockTime | The amount of wall clock time the job has been |
| | executing. |
+------------------+--------------------------------------------------+
| CPUTime | The accumulated CPU time (in CPU seconds) used |
| | by the job. |
+------------------+--------------------------------------------------+
| IOCount | The number of I/O operations performed by the |
| | job. |
+------------------+--------------------------------------------------+
| RealStg | The amount of real storage the job is using in |
| | the private region. |
+------------------+--------------------------------------------------+
| Type | The type of job. Valid values are: |
| | |
| | JOB A batch job |
| | STC A started task |
+------------------+--------------------------------------------------+
| JobStat | The status of the job. Valid values are: |
| | NS Nonswappable |
| | LSW Logically swapped |
| | GO OUT Currently being swapped out |
| | GO IN Currently being swapped in |
| | IN Swapped in |
| | OUT TO Swapped out--terminal output wait |
| | OUT TI Swapped out--terminal input wait |
| | OUT LW Swapped out--long wait |
| | OUT XS Swapped out--auxiliary storage |
| | shortage |
| | OUT RS Swapped out--real storage shortage |
| | OUT DW Swapped out--detected wait |
| | OUT RQ Swapped out--requested swap |
| | OUT NQ Swapped out--enqueue exchange swap |
| | OUT EX Swapped out--exchange on recommended |
| | value |
| | OUT US Swapped out--unilateral swap |
| | OUT TS Swapped out--transition swap |
| | OUT IC Swapped out--improve central storage |
| | OUT IP Swapped out--improve system paging |
| | OUT MR Swapped out--make room |
| | OUT AW Swapped out--APPC wait |
| | OUT OI Swapped out--input wait |
| | OUT OO Swapped out--output wait |
| | OUT LS Swapped out--logical swap |
| | OUT LF Swapped out--logical swap fail |
| | OUT SR Swapped out--real swap |
| | blank No address space found with the |
| | specified jobname |
+------------------+--------------------------------------------------+
| Stepname | The current stepname. Stepnames are displayed |
| | only for jobs that have a stepname coded in the |
| | JCL. |
+------------------+--------------------------------------------------+
| Procstep | The current procedure stepname. Procedure |
| | stepnames are displayed only for jobs that use a |
| | PROC statement in the JCL. |
+------------------+--------------------------------------------------+
| Jobnr | The job number. |
+------------------+--------------------------------------------------+
| JobClass | The job input class. Only batch jobs have a job |
| | input class. |
+------------------+--------------------------------------------------+
| Description | A description of the address space based on the |
| | jobname. The description for a jobname is |
| | defined in the parmlib member JOBNAMES. |
+------------------+--------------------------------------------------+
| Application | The CTG's Java application tag. |
| | |
| | The application value is obtained from the |
| | JVM's environment variable SYSVIEW_APPLICATION |
| | during a post discovery initialization process. |
| | |
| | If the JVM is not fully initialized, the value |
| | may be blank for a short period of time. |
| | |
| | If the environment variable has not been |
| | defined, this field will be blank. |
| | |
| | This field will be highlighted if the ASID |
| | matches the current target ASID and the PID |
| | matches the current PID or the current PID is |
| | set to "*". |
| | |
| | See the following help topic for more |
| | information: |
| | Assign JVM application names to SYSVIEW |
+------------------+--------------------------------------------------+
| PID | The process ID in hexadecimal format of the CICS |
| | Transaction Gateway. |
| | |
| | This field will be highlighted if the ASID |
| | matches the current target ASID and the PID |
| | matches the current PID or the current PID is |
| | set to "*". |
+------------------+--------------------------------------------------+
| PIDD | The process ID in decimal format of the CICS |
| | Transaction Gateway. |
| | |
| | This field will be highlighted if the ASID |
| | matches the current target ASID and the PID |
| | matches the current PID or the current PID is |
| | set to "*". |
+------------------+--------------------------------------------------+
| TCB | The TCB owning the CTG. |
+------------------+--------------------------------------------------+
| ASCB | The ASCB address for the job. |
+------------------+--------------------------------------------------+
| SSID | The subsystem ID of the data collector agent. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DISable | Disable all request monitoring exits. |
+------------------+--------------------------------------------------+
| ENAble | Enable all request monitoring exits. |
+------------------+--------------------------------------------------+
| RESet | Resets CTG health to 100. |
+------------------+--------------------------------------------------+
| RESETZer | Resets CTG health to 0. This function is only |
| | supported for CTG version 9.3.0 or newer. |
+------------------+--------------------------------------------------+
| Select | Sets the current target ASID, PID and TCB to |
| | the selected entry. |
+------------------+--------------------------------------------------+
| SET | Sets the current target ASID, PID and TCB to |
| | the selected entry. |
+------------------+--------------------------------------------------+
| SHUTdown | Shutdown the CICS Transaction Gateway. |
+------------------+--------------------------------------------------+
| SHUTImm | Immediately shutdown the CICS Transaction |
| | Gateway without waiting for work to complete. |
+------------------+--------------------------------------------------+
| STOP | Stop the CICS Transaction Gateway address space. |
+------------------+--------------------------------------------------+
| TRAce | Set the CTG trace level. The command string will |
| | be copied to the primary command line. Replace |
| | the tracelvl parameter with a valid trace level. |
| | |
| | Valid values are: |
| | 0 - No tracing |
| | |
| | 1 - Only exceptions are traced |
| | |
| | 2 - Trace level 1 + entry/exit of methods |
| | |
| | 3 - Trace level 2 + some more internals |
| | |
| | 4 - Full debug tracing |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| ACTjob | Invokes the ACTJOB command to display job data |
| | collection activity. |
+------------------+--------------------------------------------------+
| EXCI | Invokes the EXCI screen on the CTGSRVR command |
| | to display CICS servers connected to the CICS |
| | Transaction Gateway communicating via EXCI |
| | protocol. |
+------------------+--------------------------------------------------+
| GC | Invokes the JVMGC command to display JVM |
| | garbage collection information. |
+------------------+--------------------------------------------------+
| HEAPs | Invokes the JVMHEAPS command to display JVM |
| | heap information. |
+------------------+--------------------------------------------------+
| IPIC | Invokes the IPIC screen on the CTGSRVR command |
| | to display CICS servers connected to the CICS |
| | Transaction Gateway communicating via IPIC |
| | protocol.
+------------------+--------------------------------------------------+
| JJobque | Invokes the JJOBQUE command for the selected |
| LIstjobs | jobname. |
| LJ | |
+------------------+--------------------------------------------------+
| JVM | Invokes the JVMLIST command to display |
| | information about the selected CTG instance's |
| | JVM. |
+------------------+--------------------------------------------------+
| JVMMenu | Invokes the MENU JVM command to display a list |
| | of JVM commands. |
+------------------+--------------------------------------------------+
| LISTFile | Invokes the LISTFILE command for the selected |
| LF | jobname. |
+------------------+--------------------------------------------------+
| LOG | Invokes the CTGLOG command to display CTG SMF |
| | type 111 records for the selected jobname. |
+------------------+--------------------------------------------------+
| LSERVers | Invokes the CTGLSRVR command to display CICS |
| | Transaction Gateway logical servers. |
+------------------+--------------------------------------------------+
| SERVers | Invokes the CTGSRVR command to display the CICS |
| | servers connected to the CICS Transaction |
| | Gateway. |
+------------------+--------------------------------------------------+
| THreads | Invokes the JVMTHRDS command to display JVM |
| | thread information. |
+------------------+--------------------------------------------------+
| WEBServc | Invokes the CTGWEBSV command to display CICS |
| | Transaction Gateway web services information. |
+------------------+--------------------------------------------------+
Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| OPTions | Alter the display by modifying profile options |
| | specific to this command. The values will be |
| | preserved in the profile. |
| | |
| | This subcommand accepts the following |
| | parameters: |
| | |
| | TOTAL Fields that support total and |
| | interval values will display |
| | values calculated since the CTG |
| | was successfully initialized. |
| | |
| | INTERVAL Fields that support total and |
| | interval values will display |
| | values calculated for the |
| | current statistics interval. |
| | This interval is defined by the |
| | StatInt parameter in the Gateway |
| | INI file. |
+------------------+--------------------------------------------------+
| REFresh | Refreshes the display data. |
+------------------+--------------------------------------------------+

Related Information

The data for this command requires the following:


* JVM component
* JVM Data Collector
* A SYSVIEW JVM data collector agent

Security Requirements

For security requirements, use the link: CTGLIST command security

Line commands that take actions directly against CTG instances on this
display are performed by invoking the CTGSET command. You can secure
these updates by securing access to the CTGSET command or subcommand.
CTGLOG

CTGLOG Command

The CTGLOG command displays and formats SMF records created by


CICS Transaction Gateway daemons. The source of the records must
be a log stream. The log stream can be managed by SYSVIEW or by
the IBM SMF facility. See CICS Transaction Gateway SMF Records
for more information.

A log can potentially contain a very large number of records. For


this reason, only the specified number of records will be displayed.
This set of records is referred to as the "display window", and is
controlled by the LINES parameter on the command or the LINES
parameter on the OPTIONS subcommand.

Suggested Screen Size

This command is best viewed on a display with a screen size that is


greater than 80 columns.
Follow this link for more information: Dynamic screen sizes

The data contained in the display fields can be large.


The provided field formats have been ordered and sized to display the
information based on typical data. You are encouraged to create new
formats or alter the supplied field formats to meet your needs.

Command Syntax

+------------------+--------------------------------------------------+
| | |
| &HelpMember | [ STREAM logstream ] |
| | |
| | [ DATE * | date ] |
| | [ TIME * | time ] |
| | |
| | [ READNext ] |
| | [ READPrev ] |
| | |
| | [ PERiod hh:mm:ss ] |
| | [ CUSHion hh:mm:ss ] |
| | |
| | [ LINEs datalines ] |
| | [ LIMit readlimit ] |
| | [ ELAPsedlimit hh:mm:ss ] |
| | |
| | [ RECtime END | START ] |
| | |
| | [ DISCARD ] |
| | [ NODISCARD ] |
| | |
| | [ FILTER ] |
| | [ NOFILTER ] |
| | |
| | [ SMFid smfid ] |
| | [ JOBname jobname ] |
| | [ APPLid applid ] |
| | [ TYPE type ] |
| | |
| | [ REQuests oper value ] |
| | [ RESPTime oper value ] |
| | [ IOTime oper value ] |
| | [ REQLen oper value ] |
| | [ RESPLen oper value ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| STREAM logstream | Specifies the log stream name from which to |
| | display data. |
| | |
| | If no log stream name is specified, the parmlib |
| | member LGLOOKUP will be used to locate a |
| | matching log stream name. |
| | |
| | Use the following "short" names to substitute |
| | the default log stream name for the indicated |
| | record type: |
| | |
| | AUDIT - Audit events |
| | CICSEITL - CICS EXEC interface trace log |
| | CICSSYSD - CICS system interval analysis |
| | CICSTRAN - CICS transaction log |
| | CICSTSUM - CICS transaction summary log |
| | CICSXLOG - CICS exception log |
| | CTGLOG - CICS Transaction Gateway log |
| | IMSIMTR - IMS transaction log |
| | IMSIMRS - IMS region summary log |
| | IMSIMTS - IMS transaction summary log |
| | IMSOMAT - IMS OM audit trail log |
| | MQSDATA - MQ request history log |
| | OPERLOG - Operations log stream |
| | PLOTLOG - Historical plot log |
| | SMFDATA - SMF log |
| | XLOG - Exception log |
| | ZCNRLOG - z/OS Connect request log |
| | |
+------------------+--------------------------------------------------+
| DATE date | Position to specified date in log. |
| | Read records from the starting point in a |
| | forward direction ( youngest to newest ). |
| | |
| | date - The date value must be specified |
| | using the date format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | Query current date format |
| | |
| | * - Use the current date (today). |
| | |
| | -days - Position to today's date |
| | minus the specified number |
| | of days. |
| | |
| | If a DATE value is supplied and a TIME |
| | value is not supplied, the current TIME (now) |
| | will be used. |
| | |
+------------------+--------------------------------------------------+
| TIME time | Position to specified time in log. |
| | |
| | time - The time value must be specified |
| | using the time format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | Query current time format |
| | |
| | * - Use the current time (now). |
| | |
| | nnAM - The time value can also be |
| | nnPM specified using one of the |
| | following values: |
| | 12AM | 1AM | 2AM | ... | 11AM |
| | 12PM | 1PM | 2PM | ... | 11PM |
| | NOON | MIDNIGHT |
| | |
| | -adjust - Set the time value to the |
| | +adjust current time (now) plus or minus |
| | the specified adjustment value. |
| | |
| | Example adjustment values: |
| | |
| | -0.500000 - 0.5 seconds |
| | -60 - 60 seconds |
| | -120Sec - 120 seconds |
| | -5MINutes - 5 minutes |
| | -1Hours - 1 hour |
| | -1Days - 1 day |
| | -hh:mm:ss - hours:minutes:seconds |
| | |
| | +0.500000 + 0.5 seconds |
| | +60 + 60 seconds |
| | +120Sec + 120 seconds |
| | +5MINutes + 5 minutes |
| | +1Hours + 1 hour |
| | +1Days + 1 day |
| | +hh:mm:ss + hours:minutes:seconds |
| | |
| | If a TIME value is supplied and a DATE |
| | value is not supplied, the current DATE |
| | will be used. |
| | |
+------------------+--------------------------------------------------+
| READPrev | If a date or time value is specified, READPREV |
| | specifies that the log is to be read starting |
| | at the date and time and read backwards |
| | (youngest to oldest). |
| | |
| | If date or time is not specified, the READPREV |
| | parameter is ignored. |
| | |
+------------------+--------------------------------------------------+
| READNext | If a date or time value is specified, READNEXT |
| | specifies that the log is to be read starting |
| | at the date and time and read forwards |
| | (oldest to youngest). |
| | |
| | If date or time is not specified, the READNEXT |
| | parameter is ignored. |
| | |
+------------------+--------------------------------------------------+
| PERiod hh:mm:ss | Specifies the time period for which records are |
| | to be displayed. |
| | |
| | Default : 0 (unlimited) |
| | |
| | Example values: |
| | |
| | NONE - No period (unlimited) |
| | 0 - No period (unlimited) |
| | 0.500000 - 0.5 seconds |
| | 60 - 60 seconds |
| | 120Sec - 120 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | 1Days - 1 day |
| | 1MONths - 1 month |
| | 1Years - 1 year |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| CUSHion hh:mm:ss | Specifies the time period cushion for which |
| | records are to be read for display. |
| | |
| | Data records stored in an MVS log stream are |
| | sequenced or sorted based on the actual time |
| | the record was written to the stream. |
| | |
| | This does not guarantee that the records are |
| | sorted in a time sequence based on the |
| | date and time information that is potentially |
| | contained within each record. |
| | |
| | For this reason, when a user wants to display |
| | a specific time period of data, additional |
| | records must be read on the front and back |
| | end of the read process to ensure that the |
| | records that might be out of sequence are |
| | included. |
| | |
| | The time period cushion specifies the extra |
| | records to be read. |
| | |
| | Example Cushion: |
| | |
| | Start time: 8AM |
| | Period : 1 Hour |
| | Cushion : 5 minutes |
| | |
| | Read Begin : 07:55:00 |
| | -- Discard records |
| | Display Begin : 08:00:00 |
| | -- Display records |
| | Display End : 09:00:00 |
| | -- Discard records |
| | Read End : 09:05:00 |
| | |
| | Example values: |
| | |
| | NONE - No cushion |
| | 0 - No cushion |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| LINEs count | Specifies the maximum number of data rows to |
| | be displayed. |
| | |
| | Default : 25000 |
| | Minimum : 1 |
| | Maximum : 1000000 |
| | |
| | Specifying the LINES value with the primary |
| | command syntax does not alter or change the |
| | default value stored in the user profile. |
| | |
| | The default value can be altered using the |
| | subcommand: OPTIONS LINES count |
| | |
| | The actual number of data rows displayed may |
| | be greater than the specified LINES value if |
| | a record or message expanded to multiple lines. |
| | |
+------------------+--------------------------------------------------+
| LIMit count | Specifies the maximum number of records to be |
| | read. |
| | |
| | Specifying the LIMIT value with the primary |
| | command syntax does not alter or change the |
| | default value stored in the user profile. |
| | |
| | The default value can be altered using the |
| | subcommand: OPTIONS LIMIT count |
| | |
| | Default : 1000000 |
| | |
+------------------+--------------------------------------------------+
| ELAPsed hh:mm:ss | Specifies the elapsed time limit for reading |
| | or searching the log streams for desired |
| | data. |
| | |
| | If the log stream being searched is very large, |
| | the search time required can be substantial. |
| | This is especially true if a large number |
| | of data LINES has been requested and the |
| | number of data records that would satisfy |
| | the search request are spread across the |
| | entire log stream. |
| | |
| | The log browse search will be interrupted |
| | when the elapsed time limit is reached. |
| | |
| | The search can be continued using the |
| | subcommands: NEXT or PREVIOUS |
| | |
| | Example values: |
| | |
| | NONE - No timeout |
| | 0 - No timeout |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| RECORDTime | Specifies whether the "start" or "end" date |
| RECTime | and time should be used for the records. |
| | |
| | Not all records have a start and an end |
| | time. Records that do not have both a start |
| | and an end time are considered "events". |
| | |
| | Records that are interval based typically |
| | do have a start and end time. |
| | |
| | Records that are event based typically do not. |
| | |
| | Valid values: |
| | |
| | END |
| | START |
| | EVENT |
| | |
+------------------+--------------------------------------------------+
| DISCard | Specifies whether records found to be in the |
| NODISCard | time period cushion should be discarded or |
| | kept. |
| | |
| | DISCARD - Discard the records found in |
| | the cushion. (default) |
| | |
| | NODISCARD - Keep the records found in the |
| | cushion. |
| | |
+------------------+--------------------------------------------------+
| FILTER | Display a "filter" screen to allow the |
| NOFILTER | entering of command syntax parameters to |
| | filter the data. |
| | |
| | When the "FILTER" keyword is entered as part |
| | of the primary command, the parameters entered |
| | will be used to populate the filter display. |
| | |
| | After entering desired data on the filter |
| | display, the following function keys can |
| | be used: |
| | |
| | ENTER - Validate the data entered. |
| | No processing occurs. |
| | |
| | F1 - Invoke HELP for the filter display. |
| | |
| | F3 - Validate the data entered and |
| | process the data to build the |
| | display. |
| | |
| | F12 - Do not validate data. No processing |
| | occurs. The existing data is |
| | redisplayed. |
| | |
| | FILTER - Display filter. |
| | |
| | NOFILTER - Do not display filter (default). |
| | |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| SMFid | Specify the system identifier to be displayed. |
| | |
| | Syntax: SMFid smfid |
| | |
| | Maximum parameter length: 4 |
| | |
| | Generic or wildcard values are supported. |
| | VLMC: = |
| | FLMC: * |
+------------------+--------------------------------------------------+
| JOBname | Specify the jobname of the CICS Transaction |
| | Gateway daemon to be displayed. |
| | |
| | Syntax: JOBNAME jobname |
| | |
| | Maximum parameter length: 8 |
| | |
| | Generic or wildcard values are supported. |
| | VLMC: = |
| | FLMC: * |
+------------------+--------------------------------------------------+
| APPLid | Specify the CTG applid to be displayed. |
| | |
| | Syntax: TYPE type |
| | |
| | Maximum parameter length: 8 |
| | |
| | Generic or wildcard values are supported. |
| | VLMC: = |
| | FLMC: * |
+------------------+--------------------------------------------------+
| TYPE | Specify the statistics type to be displayed. |
| | |
| | Syntax: TYPE type |
| | |
| | Maximum parameter length: 8 |
| | |
| | Valid values are: |
| | |
| | EOD - Statistics taken at end of day |
| | INTERVAL - Statistics taken during interval |
| | SHUTDOWN - Statistics taken at CTG shutdown |
| | |
| | Generic or wildcard values are supported. |
| | VLMC: = |
| | FLMC: * |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REQuests | Display data for records that match the |
| | specified criteria for number of CTG requests. |
| | |
| | Valid values are: |
| | |
| | Minimum = 0 |
| | Maximum = 250000 |
| | |
| | Syntax: REQuests oper count |
+------------------+--------------------------------------------------+
| RESPTime | Display data for requests that match the |
| | specified criteria for CTG average response |
| | time. |
| | |
| | Syntax: RESPTime oper time |
+------------------+--------------------------------------------------+
| IOTime | Display data for requests that match the |
| | specified criteria for CTG average response |
| | including I/O time. |
| | |
| | Syntax: IOTime oper time |
+------------------+--------------------------------------------------+
| REQLen | Display data for records that match the |
| | specified criteria for average client request |
| | body length. |
| | |
| | Valid values are: |
| | |
| | Minimum = 0 |
| | Maximum = 250000 |
| | |
| | Syntax: REQLen oper count |
+------------------+--------------------------------------------------+
| RESPLen | Display data for records that match the |
| | specified criteria for average client response |
| | body length. |
| | |
| | Valid values are: |
| | |
| | Minimum = 0 |
| | Maximum = 250000 |
| | |
| | Syntax: RESPLen oper count |
+------------------+--------------------------------------------------+
| oper | Selection operator |
| | Valid values are: |
| | |
| | EQ, = |
| | LT, [ |
| | LE, [= |
| | GT, ] |
| | GE, ]= |
| | NE, ¬=, [] |
| | NG, ¬] |
| | NL, ¬[ |
| | |
+------------------+--------------------------------------------------+
| time | Time value in seconds. |
| | The value can be specified in the following |
| | formats: |
| | |
| | 0.000000 |
| | HH:MM:SS |
| | |
+------------------+--------------------------------------------------+
| count | Count or decimal value. |
| | |
+------------------+--------------------------------------------------+

Information Fields

The Information Section area is cursor selectable.


If the cursor is in the Information Section and the [ENTER] key
is pressed, the "FILTER" panel will be displayed.

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| LogStream | The name of the log stream from which data |
| | is being displayed. |
| | |
| | The keyword "ASIS" will follow the log stream |
| | name if the records are being read ASIS. |
| | ASIS specifies that no record decompression |
| | has been requested. |
+------------------+--------------------------------------------------+
| Retention | The log stream retention period. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Available | The time and date of the first and last records |
| | in the physical log stream. |
| | |
| | Commands that display the contents of log |
| | streams will only display those records that |
| | are relevant to the specific command. The log |
| | stream may contain other records. |
| | |
| | The available time and date information may not |
| | reflect the actual usable data records if the |
| | log stream contains data different than what |
| | corresponds to the active command. |
+------------------+--------------------------------------------------+
| Searched | The searched range of records processed. |
+------------------+--------------------------------------------------+
| Displayed | The current "display window" of records being |
| | displayed. |
| | |
| | The time and date of the first and last records |
| | displayed. |
| | |
| | This value can be modified to position to a new |
| | starting time and date. |
+------------------+--------------------------------------------------+
+------------------+--------------------------------------------------+
| Lines | Specifies the maximum number of data rows |
| | to be displayed. |
+------------------+--------------------------------------------------+
| Limit | Specifies the maximum number of records to be |
| | read in order to satisfy the specified "Lines" |
| | value. |
| | The value "NONE" indicates that no limit or |
| | "0" was specified. |
+------------------+--------------------------------------------------+
| Period | Specifies the time period for which records are |
| | to be displayed. |
| | The value "NONE" indicates that no time period |
| | was specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: Date,A,BlockID,A,SubRec,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Date | The date and time of the record. |
| Time | |
| | The values can be either the start or end |
| | times associated with the request. |
| | This can be specified using the RECTIME |
| | parameter. |
+------------------+--------------------------------------------------+
| Jobname | The name of the job executing the CICS |
| | Transaction Gateway daemon. |
| | |
| | Statistics ID: GD_SNAME |
+------------------+--------------------------------------------------+
| Requests | The number of API calls (ECI, ESI) and XA |
| | requests that have been processed. Successful |
| | and failed requests are included. Administrative |
| | requests and handshakes are excluded. |
| | |
| | Statistics ID: GD_IALLREQ |
+------------------+--------------------------------------------------+
| RespTime | The average time for the CTG to respond to API |
| | (ECI, ESI) and XA (two-phase commit) requests |
| | from remote clients. Successful and failed |
| | requests are included. |
| | |
| | Statistics ID: GD_IAVRESP |
+------------------+--------------------------------------------------+
| IOTime | The average time for the CTG to respond to API |
| | (ECI, ESI) and XA requests from remote clients |
| | including network I/O time. Successful and |
| | failed requests are included. |
| | |
| | Statistics ID: GD_IAVRESPIO |
+------------------+--------------------------------------------------+
| ReqExit | The number of times the CICS request exit was |
| | called. |
| | |
| | Statistics ID: GD_IHAEXIT |
+------------------+--------------------------------------------------+
| ReqLen | The average amount of request data received from |
| | client applications. |
+------------------+--------------------------------------------------+
| RespLen | The average amount of response data sent to |
| | client applications. |
+------------------+--------------------------------------------------+
| CSReq | The number of requests to CICS servers that |
| | have been processed. This number includes |
| | successful and failed requests. |
| | |
| | Statistics ID: CS_IALLREQ |
+------------------+--------------------------------------------------+
| CSResT | The average time taken for connected CICS |
| | servers to respond to the Gateway daemon. |
| | |
| | Statistics ID: CS_IAVRESP |
+------------------+--------------------------------------------------+
| IPICFail | The number of failures on IPIC sessions to CICS |
| | servers. |
| | |
| | Statistics ID: /CS_ISESSFAIL |
+------------------+--------------------------------------------------+
| EXCIFail | The number of the times the Gateway daemon has |
| | tried and failed to allocate a pipe to a CICS |
| | server. |
| | |
| | Statistics ID: CS_IALLOCFAIL |
+------------------+--------------------------------------------------+
| CommFail | The number of times communication with a CICS |
| | server has failed after a connection has already |
| | been established or when there has been a |
| | failure with the link during communication with |
| | the server. |
| | |
| | Statistics ID: CS_ICOMMSFAIL |
+------------------+--------------------------------------------------+
| ConnFail | The number of times an attempt to connect to a |
| | CICS server has failed. |
| | |
| | Statistics ID: CS_ICONNFAIL |
+------------------+--------------------------------------------------+
| ConnLost | The number of times an established connection |
| | with a CICS server has been lost. |
| | |
| | Statistics ID: CS_ILOSTCONN |
+------------------+--------------------------------------------------+
| TimeOut | The number of times an attempt to connect to a |
| | CICS server has failed. |
| | |
| | Statistics ID: CS_IIDLETIMEOUT |
+------------------+--------------------------------------------------+
| Realloc | The number of times that a worker thread has to |
| | deallocate its existing pipe and reallocate a |
| | new pipe because the existing pipe points to a |
| | different CICS server from that required by the |
| | request. This field applies only when the |
| | environment variable CTG_PIPE_REUSE is set to |
| | ONE. This field does not include cases where the |
| | pipe for the worker thread was deallocated and |
| | reallocated because the CICS server was not |
| | available are excluded. |
| | |
| | Statistics ID: CS_IREALLOC |
+------------------+--------------------------------------------------+
| WSReq | The number of web service requests that have |
| | been processed. Successful and failed requests |
| | are included. |
| | |
| | Statistics ID: WS_IALLREQ |
+------------------+--------------------------------------------------+
| WSHWM | The high water mark of web service transactions |
| | that have been in flight at the same time. |
| | |
| | Statistics ID: WS_IREQHI |
+------------------+--------------------------------------------------+
| WSResT | The average time for web services to respond to |
| | requests from remote clients. Successful and |
| | failed requests are included. |
| | |
| | Statistics ID: WS_IAVRESP |
+------------------+--------------------------------------------------+
| WTHWM | The high water mark of worker threads |
| | concurrently in use for the current interval. |
| | |
| | Statistics ID: WT_IALLOCHI |
+------------------+--------------------------------------------------+
| WTTimeOut | The number of times a worker thread could not be |
| | allocated within the defined workertimeout |
| | length of time. The workertimeout value is set |
| | in the CTG INI file. |
| | |
| | Statistics ID: WT_ITIMEOUTS |
+------------------+--------------------------------------------------+
| GC | The number of garbage collection events. |
| | |
| | Statistics ID: SE_IGCCOUNT |
+------------------+--------------------------------------------------+
| GCTime | The length of time taken by the JVM for garbage |
| | collection. |
| | |
| | Statistics ID: SE_IGCTIME |
+------------------+--------------------------------------------------+
| HeapGc | The Gateway daemon JVM heap size after the last |
| | garbage collection. |
| | |
| | Statistics ID: SE_CHEAPGCMIN |
+------------------+--------------------------------------------------+
| CMCrt | The number of connection manager threads |
| | created. |
| | |
| | Statistics ID: CM_ICREATED |
+------------------+--------------------------------------------------+
| CMAlloc | The number of allocations for connection manager |
| | threads representing the number of connections |
| | that have been established from remote clients. |
| | |
| | Statistics ID: CM_IALLOC |
+------------------+--------------------------------------------------+
| CMTimeOut | The number of times that the Gateway daemon |
| | failed to allocate a connection manager thread |
| | within the length of time defined by the |
| | connecttimeout parameter in the Gateway INI |
| | file. |
| | |
| | Statistics ID: CM_ITIMEOUTS |
+------------------+--------------------------------------------------+
| CMHWM | The high water mark of connection manager |
| | threads concurrently allocated to client |
| | applications for the current interval. |
| | |
| | Statistics ID: CM_IALLOCHI |
+------------------+--------------------------------------------------+
| Type | The statistics type. |
| | |
| | Possible values are: |
| | |
| | EOD - Statistics taken at end of day |
| | INTERVAL - Statistics taken during interval |
| | SHUTDOWN - Statistics taken at CTG shutdown |
+------------------+--------------------------------------------------+
| Interval | A sequence number that increments each time an |
| | interval is requested. The first interval is 1. |
+------------------+--------------------------------------------------+
| Version | The version of the CICS Transaction Gateway. |
+------------------+--------------------------------------------------+
| Hostname | The hostname of the CICS Transaction Gateway. |
+------------------+--------------------------------------------------+
| SMFID | The system identifier. |
+------------------+--------------------------------------------------+
| Applid | The CICS Transaction Gateway applid. If an |
| | applid was not set, this will be the jobname. |
+------------------+--------------------------------------------------+
| SSID | The CTG subsystem identification. |
+------------------+--------------------------------------------------+
| Length | The record length. |
+------------------+--------------------------------------------------+
| BlockID | Block ID assigned to the log record. |
+------------------+--------------------------------------------------+
| SubRec | Sub-record number within a blocked physical |
| | record. Zero, if the physical record was not |
| | blocked. |
+------------------+--------------------------------------------------+
| CmpLen | Length of the compressed record |
+------------------+--------------------------------------------------+
| Cmp% | Compression percentage |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DRO | Delete records older than the entry selected. |
| | Invokes the LGDRO command. |
+------------------+--------------------------------------------------+
| PRint | Displays the detail screen for a record, prints |
| | the detail report to a sysout data set and then |
| | returns to the display screen. If a SYSOUT |
| | print data set was not open this line command |
| | will cause it to be opened. All subsequent |
| | PRINT line commands will print to the same |
| | SYSOUT data set until a PRINT CLOSE command is |
| | issued or until the session terminates. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Dump | Dump the contents of a record. |
+------------------+--------------------------------------------------+
| SD | Select and dump. |
| | |
| | A detailed report followed by a dump of the |
| | contents of the record is displayed. |
+------------------+--------------------------------------------------+
| Select | Display a formatted report for the record. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| BACkward | Read the previous block of records in the log |
| PREVious | starting with the first record displayed on the |
| | screen. The number of records read is |
| | controlled by the LINES option, which can be set |
| | using the OPTIONS subcommand. |
+------------------+--------------------------------------------------+
| EOF | Go to the end of the log. |
| EOL | |
+------------------+--------------------------------------------------+
| FORward | Read the next block of records in the log |
| NEXT | starting with the last record displayed on the |
| | screen. The number of records read is |
| | controlled by the LINES option, which can be set |
| | using the OPTIONS subcommand. |
+------------------+--------------------------------------------------+
| OPTions | Set and display miscellaneous command options. |
+------------------+--------------------------------------------------+
| POSition | Position to a time and date. |
| | |
| | Syntax : POSITION time [date] |
| | |
| | time - The time value must be specified |
| | using the time format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | If "*" is specified, the current |
| | time will be used. |
| | |
| | The time value can also be |
| | specified using one of the |
| | following values: |
| | 12AM | 1AM | 2AM | ... | 11AM |
| | 12PM | 1PM | 2PM | ... | 11PM |
| | NOON | MIDNIGHT |
| | |
| | Query current time format |
| | |
| | date - The date value must be specified |
| | using the date format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | If "*" is specified, the current |
| | date will be used. |
| | |
| | Query current date format |
| | |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| TOF | Go to the top of the log. |
| TOL | |
+------------------+--------------------------------------------------+
| FILTER | Display a "filter" screen to allow the entering |
| | command syntax parameters to filter the data. |
+------------------+--------------------------------------------------+

OPTIONS Subcommand

The OPTIONS subcommand sets and displays miscellaneous command


options.

Entering the OPTIONS subcommand with no parameters displays the


current option values.

Multiple option values can be entered as a single command.

OPTIONS Subcommand format

+------------------+--------------------------------------------------+
| OPTIONS | [options] |
+------------------+--------------------------------------------------+

OPTIONS Subcommand Parameter Values

+------------------+--------------------------------------------------+
| Value | Explanation |
+------------------+--------------------------------------------------+
| LINEs | Specifies the maximum number of data rows to |
| | be displayed. |
| | |
| | Syntax : OPTIONS LINES count |
| | |
| | Default : 25000 |
| | Minimum : 1 |
| | Maximum : 1000000 |
| | |
+------------------+--------------------------------------------------+
| LIMit | Specifies the maximum number of records to be |
| | read. |
| | |
| | Syntax : OPTIONS LIMIT count |
| | |
| | Default : 1000000 |
| | |
+------------------+--------------------------------------------------+
| PERiod | Specifies the time period for which records are |
| | to be displayed. |
| | |
| | Syntax : OPTIONS PERIOD hh:mm:ss |
| | |
| | Default : 0 (unlimited) |
| | |
| | Example values: |
| | |
| | NONE - No period (unlimited) |
| | 0 - No period (unlimited) |
| | 0.500000 - 0.5 seconds |
| | 60 - 60 seconds |
| | 120Sec - 120 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | 1Days - 1 day |
| | 1MONths - 1 month |
| | 1Years - 1 year |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| CUSHion | Specifies the time period cushion for which |
| | records are to be read for display. |
| | |
| | Data records stored in an MVS log stream are |
| | sequenced or sorted based on the actual time |
| | the record was written to the stream. |
| | |
| | This does not guarantee that the records |
| | are sorted in a time sequence based on the |
| | date and time information that is potentially |
| | contained within each record. |
| | |
| | For this reason, when a user wants to display |
| | a specific time period of data, additional |
| | records must be read on the front and back |
| | end of the read process to ensure that the |
| | records that might be out of sequence are |
| | included. |
| | |
| | The time period cushion specifies the extra |
| | records to be read. |
| | |
| | Syntax : OPTIONS CUSHION hh:mm:ss |
| | |
| | Example Cushion: |
| | |
| | Start time: 8AM |
| | Period : 1 Hour |
| | Cushion : 5 minutes |
| | |
| | Read Begin : 07:55:00 |
| | -- Discard records |
| | Display Begin : 08:00:00 |
| | -- Display records |
| | Display End : 09:00:00 |
| | -- Discard records |
| | Read End : 09:05:00 |
| | |
| | Example values: |
| | |
| | NONE - No cushion |
| | 0 - No cushion |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| ELAPsed | Specifies the elapsed time limit for reading |
| ELAPsedlimit | or searching the log streams for desired data. |
| | |
| | If the log stream being searched is very large, |
| | the search time required can be substantial. |
| | This is especially true if a large number of |
| | data LINES has been requested and the number |
| | of data records that would satisfy the search |
| | request are spread across the entire log stream. |
| | |
| | The log browse search will be interrupted |
| | when the elapsed time limit is reached. |
| | |
| | The search can be continued using the |
| | subcommands: NEXT or PREVIOUS |
| | |
| | Syntax : OPTIONS ELAPSED hh:mm:ss |
| | |
| | Default : 00:00:30 |
| | |
| | Example values: |
| | |
| | NONE - No limit |
| | 0 - No limit |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| RECORDTime | Specifies whether the "start" or "end" date |
| RECTime | and time should be used for the records. |
| | |
| | Not all records have a start and an end time. |
| | |
| | Records that are interval based typically do |
| | have a start and end time. |
| | |
| | Records that are event based typically do not. |
| | |
| | Syntax : OPTIONS RECTIME END|START |
| | |
| | Valid values are: |
| | |
| | END (default) |
| | START |
| | |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC |
| | variable. The variable created or updated is |
| | named SYSV_OPTIONS_cmdname. EXTRACT is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. EXTRACT can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+------------------+--------------------------------------------------+
| FILTER | Specifies that the "filter" display screen |
| | is to be displayed to allow the entering of |
| | command syntax parameters. |
| | |
| | The "filter" display screen will be displayed |
| | each time the command is invoked unless the |
| | NOFILTER parameter is entered as part of the |
| | primary command syntax. |
| | |
| | Syntax : OPTIONS FILTER |
| | |
+------------------+--------------------------------------------------+
| NOFILTER | Specifies that the "filter" display screen |
| | is not to be displayed. |
| | |
| | The NOFILTER option can be overridden by |
| | entering the FILTER parameter as part of the |
| | primary command syntax. |
| | |
| | The subcommand FILTER can also be used to |
| | display the "filter" display screen. |
| | |
| | Syntax : OPTIONS NOFILTER |
| | |
+------------------+--------------------------------------------------+
| RESET | Request to option values to the defaults. |
| | |
| | Syntax : OPTIONS RESET |
| | |
+------------------+--------------------------------------------------+

Related Information

SYSVIEW Usage of MVS Log Streams


CTGLSRVR

CTGLSRVR Command

The CTGLSRVR command displays a list of logical CICS servers defined


and in-use by CICS Transaction Gateway.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| CTGLSRVR | [ REGion | SYStem | XSYStem | NOXSYStem ] |
| | [ PID pid ] |
| | |
| | [ TOTal | INTerval ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | The current target address space will be |
| | displayed. Fields will only have values if the |
| | current address space is a CICS Transaction |
| | Gateway. |
| | |
| | If PID = *, all PIDs in the current address |
| | space with an installed data collector will be |
| | displayed. |
| | |
| | If PID [] *, data from an installed data |
| | collector for the PID will be displayed. |
+------------------+--------------------------------------------------+
| SYStem | All CICS Transaction Gateway address spaces on |
| | the current system with an installed data |
| | collector will be displayed. |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| PID | The PID keyword requests information to be |
| | displayed for the current address space and |
| | specified PID. |
| | |
| | Possible values are: |
| | |
| | * - All PIDs in the current address |
| | space with an installed data |
| | collector will be displayed. |
| | |
| | xxxxxxxx - Specifies the PID in the current |
| | address space to be displayed if |
| | the process ID has an installed |
| | data collector. |
| | 1 to 8 hexadecimal digits. |
| | |
| | Example: PID 0304015B |
| | |
| | nnnnnnnnn. - Specifies the PID in the current |
| | address space to be displayed if |
| | the process ID has an installed |
| | data collector. |
| | 1 to 10 decimal digits. Must end |
| | with a period '.' to indicate |
| | a decimal value. |
| | |
| | Example: PID 123456789. |
+------------------+--------------------------------------------------+
| TOTal | Fields that support total and interval values |
| | will display values calculated since the CTG was |
| | successfully initalized. |
+------------------+--------------------------------------------------+
| INTerval | Fields that support total and interval values |
| | will display values calculated for the current |
| | statistics interval. This interval is defined by |
| | the StatInt parameter in the Gateway INI file. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID (ASID) of the current |
| | address space. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier (Jobid) of the current |
| | address space. This is a concatenation of |
| | the current job type and job number. |
| | |
| | Example: TSU03654 |
+------------------+--------------------------------------------------+
| PID | The current process ID (PID) of a JVM with an |
| | installed JVM data collector. |
| | |
| | The PID value is used to specify the data to be |
| | displayed in JOB mode. |
| | |
| | Possible values are: |
| | |
| | * - Indicates that all PIDs for the |
| | current address space with an |
| | installed data collector will be |
| | displayed. |
| | |
| | xxxxxxxx - Indicates that only the specified |
| | PID for the current address space |
| | will be evaluated or displayed. |
| | |
| | The PID can be set using the following command: |
| | |
| | SET PID * | xxxxxxxx |
| | |
| | When the current target address space is |
| | changed, the PID value will be set to "*". |
| | |
+------------------+--------------------------------------------------+
| Mode | The current display mode. |
| | |
| | Possible values are: |
| | |
| | JOB - Data will be displayed for the |
| | current address space. |
| | |
| | If PID = *, all PIDs with an |
| | installed data collector will be |
| | displayed. |
| | |
| | If PID [] *, data from an |
| | installed data collector for the |
| | PID will be displayed. |
| | |
| | SYSTEM - All jobs on the current system. |
| | |
| | All PIDs in all address spaces |
| | with an installed data collector |
| | will be displayed. |
| | |
| | XSYSTEM - All jobs on all systems. |
| | |
| | All PIDs in all address spaces |
| | with an installed data collector |
| | will be displayed. |
| | |
| | All connected cross-system LPARs |
| | or systems will be included. |
| | |
+------------------+--------------------------------------------------+
| MonCtg | Displays the state of the JVM agent monitoring |
| | the current target CICS Transaction Gateway |
| | address space. This field will only appear if |
| | the current target address space is a CICS |
| | Transaction Gateway. |
| | |
| | Possible values are: |
| | |
| | NOTCONFIG - The CTG was configured to be |
| | monitored by the JVM agent, |
| | but either the monctg option |
| | was not passed to the JVM |
| | agent or the monctg option |
| | was specified as disabled. |
| | General JVM monitoring is |
| | still available. |
| | |
| | INITIALIZING - CTG monitoring is starting. |
| | CTG statistics are not |
| | available until the CTG |
| | initializes. |
| | |
| | INITIALIZED - CTG monitoring is fully |
| | initialized. |
+------------------+--------------------------------------------------+
| Interval | The age of the current statistics interval for |
| | the current target CICS Transaction Gateway |
| | address space. This field will only appear if |
| | the current target address space is a CICS |
| | Transaction Gateway. |
+------------------+--------------------------------------------------+
| IntervalEnd | The time of the next scheduled interval |
| | statistics reset event for the current target |
| | CICS Transaction Gateway address space. This |
| | field will only appear if the current target |
| | address space is a CICS Transaction Gateway. |
+------------------+--------------------------------------------------+
| Options | Lists the current effective options. These |
| | options can be the original initial defaults, |
| | defaults overridden with the OPTIONS subcommand, |
| | or options specified on the CTGLSRVR command. |
| | |
| | These fields can be toggled by selecting the |
| | field. Any overtyped input is ignored. |
| | |
| | Possible values are: |
| | |
| | TOTAL Fields that support total and |
| | interval values will display |
| | values calculated since the CTG |
| | was successfully initialized. |
| | |
| | INTERVAL Fields that support total and |
| | interval values will display |
| | values calculated for the |
| | current statistics interval. |
| | This interval is defined by the |
| | StatInt parameter in the Gateway |
| | INI file. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,LServer,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The name of the job executing the CICS |
| | Transaction Gateway. |
| | |
| | This field will be highlighted if it matches |
| | the current target jobname. |
+------------------+--------------------------------------------------+
| LServer | The name of the logical CICS server. |
+------------------+--------------------------------------------------+
| Requests | The number of requests to the logical CICS |
| | server that have been processed. This number |
| | includes successful and failed requests. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: LS_LALLREQ/LS_IALLREQ |
+------------------+--------------------------------------------------+
| Server | The CICS server that the logical CICS server |
| | is mapped to in the configuration file. |
| | |
| | Statistics ID: WSx_SSERVER |
+------------------+--------------------------------------------------+
| ASID | The hexadecimal address space ID executing |
| | the CICS Transaction Gateway. |
| | |
| | This field will be highlighted if it matches |
| | the current target ASID. |
+------------------+--------------------------------------------------+
| PID | The process ID in hexadecimal format of the CICS |
| | Transaction Gateway. |
| | |
| | This field will be highlighted if the ASID |
| | matches the current target ASID and the PID |
| | matches the current PID or the current PID is |
| | set to "*". |
+------------------+--------------------------------------------------+
| PIDD | The process ID in decimal format of the CICS |
| | Transaction Gateway. |
| | |
| | This field will be highlighted if the ASID |
| | matches the current target ASID and the PID |
| | matches the current PID or the current PID is |
| | set to "*". |
+------------------+--------------------------------------------------+
| TCB | The TCB of the CICS Transaction Gateway. |
+------------------+--------------------------------------------------+
| AgentTCB | The TCB of the data collector agent installed |
| | in the CICS Transaction Gateway. |
+------------------+--------------------------------------------------+
| SSID | The subsystem ID of the data collector agent. |
+------------------+--------------------------------------------------+
| Message | The message, if any, returned as the result of |
| | requesting information from the JVM data |
| | collector agent. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands


+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| SERVers | Invokes the CTGSRVR command to display CICS |
| | server statistics. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| OPTions | Alter the display by modifying profile options |
| | specific to this command. The values will be |
| | preserved in the profile. |
| | |
| | This subcommand accepts the following |
| | parameters: |
| | |
| | TOTAL Fields that support total and |
| | interval values will display |
| | values calculated since the CTG |
| | was successfully initialized. |
| | |
| | INTERVAL Fields that support total and |
| | interval values will display |
| | values calculated for the |
| | current statistics interval. |
| | This interval is defined by the |
| | StatInt parameter in the Gateway |
| | INI file. |
+------------------+--------------------------------------------------+
| REFresh | Refreshes the display data. |
+------------------+--------------------------------------------------+

Related Information

The data for this command requires the following:


* JVM component
* JVM Data Collector
* A SYSVIEW JVM data collector agent

Security Requirements

For security requirements, use the link: CTGLSRVR command security


CTGSET

CTGSET Command

The CTGSET command provides a set of functons that can take


actions against active CICS Transaction Gateway address spaces.

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTGSET | objectparms [targetparms] [options] |
| | |
+------------------+--------------------------------------------------+

Object Parameters

+--------------+------------------------------------------------------+
| Object | Function Object Identifying parms Function specific |
| ---------- | -------- ------------------------- ----------------- |
| DAEMON | function [function parms] |
| HEALTH | function [function parms] |
| IPIC | function NAme name [function parms] |
| RMExit | function [function parms] |
| TRAce | function [function parms] |
+--------------+------------------------------------------------------+

+------------------+--------------------------------------------------+
| Object | Object parameter(s) |
+------------------+--------------------------------------------------+
| DAEMON | Process requests for the CICS Transaction |
| | Gateway daemon. |
| | |
| | Function and Object Identifying Parameters: |
| | function |
| | |
| | function - The function to perform |
| | |
| | Function: |
| | STOp - Stops the daemon address space. |
| | |
| | SHUTdown - Shutdown the CICS Transaction |
| | Gateway. |
| | |
| | SHUTIMM - Immediately shutdown the CICS |
| | Transaction Gateway without waiting |
| | for work to complete. |
+------------------+--------------------------------------------------+
| HEALTH | Process requests for the health of the CICS |
| | Transaction Gateway daemon. |
| | |
| | Function and Object Identifying Parameters: |
| | function |
| | |
| | function - The function to perform |
| | |
| | Function: |
| | 100 - Set CTG health to 100. |
| | |
| | 0 - Set CTG health to 0. This is only |
| | supported for CTG versions 9.3.0 and |
| | newer. |
+------------------+--------------------------------------------------+
| IPIC | Process requests for IPIC connections. |
| | |
| | Function and Object Identifying Parameters: |
| | function |
| | NAme ipicname |
| | |
| | function - The function to perform |
| | ipicname - IPIC connection name |
| | |
| | Function: |
| | STArt - Start the specified IPIC connection. |
| | |
| | STOp - Stop the specified IPIC connection. |
+------------------+--------------------------------------------------+
| RMExit | Process requests for request monitoring exits. |
| | |
| | Function and Object Identifying Parameters: |
| | function |
| | |
| | function - The function to perform |
| | |
| | Function: |
| | DISable - Disable all request monitoring |
| | exits. |
| | |
| | ENAble - Enable all request monitoring exits. |
+------------------+--------------------------------------------------+
| TRAce | Process requests for controlling CTG trace |
| | level. |
| | |
| | Function and Object Identifying Parameters: |
| | function |
| | |
| | function - The function to perform |
| | |
| | Function: |
| | 0 - No tracing |
| | |
| | 1 - Only exceptions are traced |
| | |
| | 2 - Trace level 1 + entry/exit of methods |
| | |
| | 3 - Trace level 2 + some more internals |
| | |
| | 4 - Full debug tracing |
+------------------+--------------------------------------------------+

Target Parameters

+------------------+--------------------------------------------------+
| Target Parms | Description |
+------------------+--------------------------------------------------+
| JOBname jobname | Specifies the target jobname for the requested |
| | function. If a jobname is not specified, the |
| | current target address space ASID/jobname |
| | will be used. |
| | |
| | The jobname can be specified as: |
| | |
| | * Specific jobname |
| | * Generic jobname |
| | * Logical group name containing a list of |
| | jobnames. |
| | Logical group type = JOBNAME |
| | Syntax: ]group |
| | |
| | Example syntax: |
| | |
| | CTGSET [objectparms] JOBNAME CTGPROD [options] |
| | CTGSET [objectparms] JOBNAME WEB= [options] |
| | CTGSET [objectparms] JOBNAME ]TEST [options] |
+------------------+--------------------------------------------------+
| SYSTEM system | Specifies the target system/LPAR name. |
| | |
| | If the system name is not specified or the |
| | system name is specified as "*", the |
| | current system name will be used. |
| | |
| | If the system name is specified as "ALL", |
| | the requested function will be issued |
| | to all systems. |
+------------------+--------------------------------------------------+
| XSGROUP | Specifies the cross-system group name that |
| | contains a list of system names. The requested |
| | function will be issued to each active system |
| | within the specified group. |
| | |
| | The list of available groups with type XSSYSTEM |
| | appears on the GROUPS command. |
+------------------+--------------------------------------------------+

Option Parameters
+------------------+--------------------------------------------------+
| Options | Description |
+------------------+--------------------------------------------------+
| CONFIRM | Confirm the requested function prior to |
| | execution. |
+------------------+--------------------------------------------------+
| NOCONFIRM | Do not confirm the requested function prior to |
| | execution. |
+------------------+--------------------------------------------------+
| MSG | Messages will be issued. |
+------------------+--------------------------------------------------+
| NOMSG | Messages will not be issued. |
| | If a command syntax error occurs, a message |
| | will be issued. |
+------------------+--------------------------------------------------+

Notes

Command Syntax Examples


+---------------------------------------------------------------------+
| Object Function Parameters |
| ----------- ------------------- --------------------------------- |
| DAEMON STOp |
| SHUTdown |
| SHUTIMM |
| |
| HEALTH 100 |
| 0 |
| |
| IPIC STArt NAme ipicname |
| STOp NAme ipicname |
| |
| RMExit DISable |
| ENAble |
| |
| TRAce 0 |
| 1 |
| 2 |
| 3 |
| 4 |
+---------------------------------------------------------------------+

Security Requirements

For security requirements, use the link: CTGSET command security


CTGSRVR

CTGSRVR Command

The CTGSRVR command displays a list of CICS servers to which a CICS


Transaction Gateway is connected.

The CTGSRVR command has three screens: SUMMARY, EXCI, and IPIC. Each
screen will display a different set of data fields.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| CTGSRVR | [ REGion | SYStem | XSYStem | NOXSYStem ] |
| | [ PID pid ] |
| | |
| | [ TOTal | INTerval ] |
| | [ SUMmary | EXCI | IPIC ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | The current target address space will be |
| | displayed. Fields will only have values if the |
| | current address space is a CICS Transaction |
| | Gateway. |
| | |
| | If PID = *, all PIDs in the current address |
| | space with an installed data collector will be |
| | displayed. |
| | |
| | If PID [] *, data from an installed data |
| | collector for the PID will be displayed. |
+------------------+--------------------------------------------------+
| SYStem | All CICS Transaction Gateway address spaces on |
| | the current system with an installed data |
| | collector will be displayed. |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| PID | The PID keyword requests information to be |
| | displayed for the current address space and |
| | specified PID. |
| | |
| | Possible values are: |
| | |
| | * - All PIDs in the current address |
| | space with an installed data |
| | collector will be displayed. |
| | |
| | xxxxxxxx - Specifies the PID in the current |
| | address space to be displayed if |
| | the process ID has an installed |
| | data collector. |
| | 1 to 8 hexadecimal digits. |
| | |
| | Example: PID 0304015B |
| | |
| | nnnnnnnnn. - Specifies the PID in the current |
| | address space to be displayed if |
| | the process ID has an installed |
| | data collector. |
| | 1 to 10 decimal digits. Must end |
| | with a period '.' to indicate |
| | a decimal value. |
| | |
| | Example: PID 123456789. |
+------------------+--------------------------------------------------+
| TOTal | Fields that support total and interval values |
| | will display values calculated since the CTG was |
| | successfully initalized. |
+------------------+--------------------------------------------------+
| INTerval | Fields that support total and interval values |
| | will display values calculated for the current |
| | statistics interval. This interval is defined by |
| | the StatInt parameter in the Gateway INI file. |
+------------------+--------------------------------------------------+
| SUMmary | Display all CICS server connections via the |
| | summary screen. |
+------------------+--------------------------------------------------+
| EXCI | Display only CICS server connections using the |
| | EXCI protocol via the EXCI screen. |
+------------------+--------------------------------------------------+
| IPIC | Display only CICS server connections using the |
| | IPIC protocol via the IPIC screen. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID (ASID) of the current |
| | address space. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier (Jobid) of the current |
| | address space. This is a concatenation of |
| | the current job type and job number. |
| | |
| | Example: TSU03654 |
+------------------+--------------------------------------------------+
| PID | The current process ID (PID) of a JVM with an |
| | installed JVM data collector. |
| | |
| | The PID value is used to specify the data to be |
| | displayed in JOB mode. |
| | |
| | Possible values are: |
| | |
| | * - Indicates that all PIDs for the |
| | current address space with an |
| | installed data collector will be |
| | displayed. |
| | |
| | xxxxxxxx - Indicates that only the specified |
| | PID for the current address space |
| | will be evaluated or displayed. |
| | |
| | The PID can be set using the following command: |
| | |
| | SET PID * | xxxxxxxx |
| | |
| | When the current target address space is |
| | changed, the PID value will be set to "*". |
| | |
+------------------+--------------------------------------------------+
| Mode | The current display mode. |
| | |
| | Possible values are: |
| | |
| | JOB - Data will be displayed for the |
| | current address space. |
| | |
| | If PID = *, all PIDs with an |
| | installed data collector will be |
| | displayed. |
| | |
| | If PID [] *, data from an |
| | installed data collector for the |
| | PID will be displayed. |
| | |
| | SYSTEM - All jobs on the current system. |
| | |
| | All PIDs in all address spaces |
| | with an installed data collector |
| | will be displayed. |
| | |
| | XSYSTEM - All jobs on all systems. |
| | |
| | All PIDs in all address spaces |
| | with an installed data collector |
| | will be displayed. |
| | |
| | All connected cross-system LPARs |
| | or systems will be included. |
| | |
+------------------+--------------------------------------------------+
| MonCtg | Displays the state of the JVM agent monitoring |
| | the current target CICS Transaction Gateway |
| | address space. This field will only appear if |
| | the current target address space is a CICS |
| | Transaction Gateway. |
| | |
| | Possible values are: |
| | |
| | NOTCONFIG - The CTG was configured to be |
| | monitored by the JVM agent, |
| | but either the monctg option |
| | was not passed to the JVM |
| | agent or the monctg option |
| | was specified as disabled. |
| | General JVM monitoring is |
| | still available. |
| | |
| | INITIALIZING - CTG monitoring is starting. |
| | CTG statistics are not |
| | available until the CTG |
| | initializes. |
| | |
| | INITIALIZED - CTG monitoring is fully |
| | initialized. |
+------------------+--------------------------------------------------+
| Interval | The age of the current statistics interval for |
| | the current target CICS Transaction Gateway |
| | address space. This field will only appear if |
| | the current target address space is a CICS |
| | Transaction Gateway. |
+------------------+--------------------------------------------------+
| IntervalEnd | The time of the next scheduled interval |
| | statistics reset event for the current target |
| | CICS Transaction Gateway address space. This |
| | field will only appear if the current target |
| | address space is a CICS Transaction Gateway. |
+------------------+--------------------------------------------------+
| Options | Lists the current effective options. These |
| | options can be the original initial defaults, |
| | defaults overridden with the OPTIONS subcommand, |
| | or options specified on the CTGSRVR command. |
| | |
| | These fields can be toggled by selecting the |
| | field. Any overtyped input is ignored. |
| | |
| | Possible values are: |
| | |
| | SUMMARY All CICS server connections are |
| | displayed. |
| | |
| | EXCI Only CICS server connections |
| | communicating via the EXCI |
| | protocol are displayed. |
| | |
| | IPIC Only CICS server connections |
| | communicating via the IPIC |
| | protocol are displayed. |
| | |
| | TOTAL Fields that support total and |
| | interval values will display |
| | values calculated since the CTG |
| | was successfully initialized. |
| | |
| | INTERVAL Fields that support total and |
| | interval values will display |
| | values calculated for the |
| | current statistics interval. |
| | This interval is defined by the |
| | StatInt parameter in the Gateway |
| | INI file. |
+------------------+--------------------------------------------------+

Data Fields

The CTGSRVR command has three screens: SUMMARY, EXCI, and IPIC. Each
screen will display a different set of data fields. The inclusion by
screen is indicated below.

Default Sort Order: XSSystem,A,Jobname,A,Server,A,Protocol,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The name of the job executing the CICS |
| | Transaction Gateway. |
| | |
| | This field will be highlighted if it matches |
| | the current target jobname. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
+------------------+--------------------------------------------------+
| Server | The name of the CICS server connected to the |
| | CICS Transaction Gateway. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
+------------------+--------------------------------------------------+
| Protocol | The protocol used to communicate with the CICS |
| | server. |
| | |
| | Possible values are: |
| | |
| | EXCI |
| | |
| | IPIC |
| | |
| | IPICSSL |
| | |
| | SNA |
| | |
| | TCPIP |
| | |
| | Screen: SUMMARY |
| | |
| | Statistics ID: CSx_SPROTOCOL |
+------------------+--------------------------------------------------+
| Requests | The number of requests to the CICS server that |
| | have been processed. Successful and failed |
| | requests are included. |
| | |
| | This field supports total and interval values. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
| | |
| | Statistics ID: CSx_LALLREQ/CSx_IALLREQ |
+------------------+--------------------------------------------------+
| RespTime | The average time for the CICS server to respond |
| | to the Gateway daemon. |
| | |
| | This field supports total and interval values. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
| | |
| | Statistics ID: CSx_LAVRESP/CSx_IAVRESP |
+------------------+--------------------------------------------------+
| Wait | The current number of requests waiting for a |
| | response from the CICS server. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
| | |
| | Statistics ID: CSx_CWAITING |
+------------------+--------------------------------------------------+
| CommFail | The number of times communication with the CICS |
| | server has failed after a connection has already |
| | been established or when there has been a |
| | failure with the link during communication with |
| | the server. |
| | |
| | For EXCI connections, a pipe was available but |
| | the request failed. |
| | |
| | This field supports total and interval values. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
| | |
| | Statistics ID: CSx_LCOMMSFAIL/CSx_ICOMMSFAIL |
+------------------+--------------------------------------------------+
| ConnFail | The number of times an attempt to connect to the |
| | CICS server has failed. |
| | |
| | This field supports total and interval values. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
| | |
| | Statistics ID: CSx_LCONNFAIL/CSx_ICONNFAIL |
+------------------+--------------------------------------------------+
| ConnLost | The number of times an established connection |
| | with the CICS server has been lost. |
| | |
| | This field supports total and interval values. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
| | |
| | Statistics ID: CSx_LLOSTCONN/CSx_ILOSTCONN |
+------------------+--------------------------------------------------+
| TimeOut | The number of times a connection to the CICS |
| | server has timed out. |
| | |
| | This field supports total and interval values. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
| | |
| | Statistics ID: CSx_LIDLETIMEOUT/CSx_IIDLETIMEOUT |
+------------------+--------------------------------------------------+
| IPICStatus | The status of the IPIC connection to the CICS |
| | server. This field will be blank for any |
| | connection protocols other than IPIC. |
| | |
| | Possible values are: |
| | |
| | NOTSTARTED Initial state of the server |
| | connection. The Gateway accepts |
| | requests. |
| | |
| | STARTING The server connection is |
| | starting. |
| | |
| | AVAILABLE The server is connected, |
| | available, and the Gateway |
| | accepts requests. |
| | |
| | UNAVAILABLE The connection has failed and |
| | the Gateway rejects requests. |
| | |
| | STOPPING The connection is closing. The |
| | Gateway rejects new requests. |
| | The Gateway accepts requests |
| | that continue or complete |
| | outstanding work. |
| | |
| | STOPPED The connection is closed and |
| | the Gateway rejects requests. |
| | |
| | Screen: IPIC |
| | |
| | Statistics ID: CSx_CSTATUS |
+------------------+--------------------------------------------------+
| IPICCur | The current number of IPIC sessions in use with |
| | the CICS server. |
| | |
| | Screen: IPIC |
| | |
| | Statistics ID: CSx_CSESSCURR |
+------------------+--------------------------------------------------+
| IPICFail | The number of failures on IPIC sessions to the |
| | CICS server. |
| | |
| | This field supports total and interval values. |
| | |
| | Screen: IPIC |
| | |
| | Statistics ID: CSx_LSESSFAIL/CSx_ISESSFAIL |
+------------------+--------------------------------------------------+
| IPICMax | The number of IPIC sessions negotiated with the |
| | CICS server. |
| | |
| | Screen: IPIC |
| | |
| | Statistics ID: CSx_CSESSMAX |
+------------------+--------------------------------------------------+
| IPICMaxR | The number of requested IPIC sessions for the |
| | CICS server. |
| | |
| | Screen: IPIC |
| | |
| | Statistics ID: CSx_SSESSMAX |
+------------------+--------------------------------------------------+
| EXCIAlloc | The current number of allocated EXCI pipes for |
| | the CICS server. |
| | |
| | Screen: EXCI |
| | |
| | Statistics ID: CSx_CALLOC |
+------------------+--------------------------------------------------+
| EXCIFail | The number of times the Gateway daemon has tried |
| | and failed to allocate a pipe to the CICS |
| | server. |
| | |
| | This field supports total and interval values. |
| | |
| | Screen: EXCI |
| | |
| | Statistics ID: CSx_LALLOCFAIL/CSx_IALLOCFAIL |
+------------------+--------------------------------------------------+
| ReqLen | The average amount of request data sent to the |
| | CICS server. This includes both application and |
| | CICS protocol data. |
| | |
| | This field supports total and interval values. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
+------------------+--------------------------------------------------+
| RespLen | The average amount of response data received |
| | from the CICS server. This amount includes both |
| | application and CICS protocol data. |
| | |
| | This field supports total and interval values. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
+------------------+--------------------------------------------------+
| ReqLenT | The total amount of request data sent to the |
| | CICS server. This includes both application and |
| | CICS protocol data. |
| | |
| | This field supports total and interval values. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
| | |
| | Statistics ID: CSx_LREQDATA/CSx_IREQDATA |
+------------------+--------------------------------------------------+
| RespLenT | The total amount of response data received from |
| | the CICS server. This amount includes both |
| | application and CICS protocol data. |
| | |
| | This field supports total and interval values. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
| | |
| | Statistics ID: CSx_LRESPDATA/CSx_IRESPDATA |
+------------------+--------------------------------------------------+
| Applid | The APPLID of the CICS server. This field will |
| | be blank for EXCI connections. |
| | |
| | Screen: SUMMARY, IPIC |
| | |
| | Statistics ID: CSx_CAPPLID |
+------------------+--------------------------------------------------+
| ApplidQ | The APPLID qualifier of the CICS server. This |
| | field will be blank for EXCI connections. |
| | |
| | Screen: SUMMARY, IPIC |
| | |
| | Statistics ID: CSx_CAPPLIDQ |
+------------------+--------------------------------------------------+
| IPAddress | The defined host name or IP address of the CICS |
| | srver. |
| | |
| | Screen: IPIC |
| | |
| | Statistics ID: CSx_SIPADDR |
+------------------+--------------------------------------------------+
| Port | The TCP/IP port of the CICS server. |
| | |
| | Screen: IPIC |
| | |
| | Statistics ID: CSx_SIPPORT |
+------------------+--------------------------------------------------+
| ASID | The hexadecimal address space ID executing |
| | the CICS Transaction Gateway. |
| | |
| | This field will be highlighted if it matches |
| | the current target ASID. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
+------------------+--------------------------------------------------+
| PID | The process ID in hexadecimal format of the CICS |
| | Transaction Gateway. |
| | |
| | This field will be highlighted if the ASID |
| | matches the current target ASID and the PID |
| | matches the current PID or the current PID is |
| | set to "*". |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
+------------------+--------------------------------------------------+
| PIDD | The process ID in decimal format of the CICS |
| | Transaction Gateway. |
| | |
| | This field will be highlighted if the ASID |
| | matches the current target ASID and the PID |
| | matches the current PID or the current PID is |
| | set to "*". |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
+------------------+--------------------------------------------------+
| TCB | The TCB of the CICS Transaction Gateway. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
+------------------+--------------------------------------------------+
| AgentTCB | The TCB of the data collector agent installed |
| | in the CICS Transaction Gateway. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
+------------------+--------------------------------------------------+
| SSID | The subsystem ID of the data collector agent. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
+------------------+--------------------------------------------------+
| Message | The message, if any, returned as the result of |
| | requesting information from the JVM data |
| | collector agent. |
| | |
| | Screen: SUMMARY, EXCI, IPIC |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| STArt | Start IPIC connection. |
| | |
| | Screen: IPIC |
+------------------+--------------------------------------------------+
| STOp | Stop IPIC connection. |
| | |
| | Screen: IPIC |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| OPTions | Alter the display by modifying profile options |
| | specific to this command. The values will be |
| | preserved in the profile. |
| | |
| | This subcommand accepts the following |
| | parameters: |
| | |
| | SUMMARY All CICS server connections are |
| | displayed. |
| | |
| | EXCI Only CICS server connections |
| | communicating via the EXCI |
| | protocol are displayed. |
| | |
| | IPIC Only CICS server connections |
| | communicating via the IPIC |
| | protocol are displayed. |
| | |
| | TOTAL Fields that support total and |
| | interval values will display |
| | values calculated since the CTG |
| | was successfully initialized. |
| | |
| | INTERVAL Fields that support total and |
| | interval values will display |
| | values calculated for the |
| | current statistics interval. |
| | This interval is defined by the |
| | StatInt parameter in the Gateway |
| | INI file. |
+------------------+--------------------------------------------------+
| REFresh | Refreshes the display data. |
+------------------+--------------------------------------------------+

Related Information

The data for this command requires the following:


* JVM component
* JVM Data Collector
* A SYSVIEW JVM data collector agent

Security Requirements

For security requirements, use the link: CTGSRVR command security

Line commands that take actions directly against CTG instances on this display
are performed by invoking the CTGSET command. You can secure these updates by
securing access to the CTGSET command or subcommand.
CTGWEBSV

CTGWEBSV Command

The CTGWEBSV command displays a list of CICS Transaction Gateway


web services.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| CTGWEBSV | [ REGion | SYStem | XSYStem | NOXSYStem ] |
| | [ PID pid ] |
| | |
| | [ TOTal | INTerval ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | The current target address space will be |
| | displayed. Fields will only have values if the |
| | current address space is a CICS Transaction |
| | Gateway. |
| | |
| | If PID = *, all PIDs in the current address |
| | space with an installed data collector will be |
| | displayed. |
| | |
| | If PID [] *, data from an installed data |
| | collector for the PID will be displayed. |
+------------------+--------------------------------------------------+
| SYStem | All CICS Transaction Gateway address spaces on |
| | the current system with an installed data |
| | collector will be displayed. |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| PID | The PID keyword requests information to be |
| | displayed for the current address space and |
| | specified PID. |
| | |
| | Possible values are: |
| | |
| | * - All PIDs in the current address |
| | space with an installed data |
| | collector will be displayed. |
| | |
| | xxxxxxxx - Specifies the PID in the current |
| | address space to be displayed if |
| | the process ID has an installed |
| | data collector. |
| | 1 to 8 hexadecimal digits. |
| | |
| | Example: PID 0304015B |
| | |
| | nnnnnnnnn. - Specifies the PID in the current |
| | address space to be displayed if |
| | the process ID has an installed |
| | data collector. |
| | 1 to 10 decimal digits. Must end |
| | with a period '.' to indicate |
| | a decimal value. |
| | |
| | Example: PID 123456789. |
+------------------+--------------------------------------------------+
| TOTal | Fields that support total and interval values |
| | will display values calculated since the CTG was |
| | successfully initalized. |
+------------------+--------------------------------------------------+
| INTerval | Fields that support total and interval values |
| | will display values calculated for the current |
| | statistics interval. This interval is defined by |
| | the StatInt parameter in the Gateway INI file. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID (ASID) of the current |
| | address space. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier (Jobid) of the current |
| | address space. This is a concatenation of |
| | the current job type and job number. |
| | |
| | Example: TSU03654 |
+------------------+--------------------------------------------------+
| PID | The current process ID (PID) of a JVM with an |
| | installed JVM data collector. |
| | |
| | The PID value is used to specify the data to be |
| | displayed in JOB mode. |
| | |
| | Possible values are: |
| | |
| | * - Indicates that all PIDs for the |
| | current address space with an |
| | installed data collector will be |
| | displayed. |
| | |
| | xxxxxxxx - Indicates that only the specified |
| | PID for the current address space |
| | will be evaluated or displayed. |
| | |
| | The PID can be set using the following command: |
| | |
| | SET PID * | xxxxxxxx |
| | |
| | When the current target address space is |
| | changed, the PID value will be set to "*". |
| | |
+------------------+--------------------------------------------------+
| Mode | The current display mode. |
| | |
| | Possible values are: |
| | |
| | JOB - Data will be displayed for the |
| | current address space. |
| | |
| | If PID = *, all PIDs with an |
| | installed data collector will be |
| | displayed. |
| | |
| | If PID [] *, data from an |
| | installed data collector for the |
| | PID will be displayed. |
| | |
| | SYSTEM - All jobs on the current system. |
| | |
| | All PIDs in all address spaces |
| | with an installed data collector |
| | will be displayed. |
| | |
| | XSYSTEM - All jobs on all systems. |
| | |
| | All PIDs in all address spaces |
| | with an installed data collector |
| | will be displayed. |
| | |
| | All connected cross-system LPARs |
| | or systems will be included. |
| | |
+------------------+--------------------------------------------------+
| MonCtg | Displays the state of the JVM agent monitoring |
| | the current target CICS Transaction Gateway |
| | address space. This field will only appear if |
| | the current target address space is a CICS |
| | Transaction Gateway. |
| | |
| | Possible values are: |
| | |
| | NOTCONFIG - The CTG was configured to be |
| | monitored by the JVM agent, |
| | but either the monctg option |
| | was not passed to the JVM |
| | agent or the monctg option |
| | was specified as disabled. |
| | General JVM monitoring is |
| | still available. |
| | |
| | INITIALIZING - CTG monitoring is starting. |
| | CTG statistics are not |
| | available until the CTG |
| | initializes. |
| | |
| | INITIALIZED - CTG monitoring is fully |
| | initialized. |
+------------------+--------------------------------------------------+
| Interval | The age of the current statistics interval for |
| | the current target CICS Transaction Gateway |
| | address space. This field will only appear if |
| | the current target address space is a CICS |
| | Transaction Gateway. |
+------------------+--------------------------------------------------+
| IntervalEnd | The time of the next scheduled interval |
| | statistics reset event for the current target |
| | CICS Transaction Gateway address space. This |
| | field will only appear if the current target |
| | address space is a CICS Transaction Gateway. |
+------------------+--------------------------------------------------+
| Options | Lists the current effective options. These |
| | options can be the original initial defaults, |
| | defaults overridden with the OPTIONS subcommand, |
| | or options specified on the CTGWEBSV command. |
| | |
| | These fields can be toggled by selecting the |
| | field. Any overtyped input is ignored. |
| | |
| | Possible values are: |
| | |
| | TOTAL Fields that support total and |
| | interval values will display |
| | values calculated since the CTG |
| | was successfully initialized. |
| | |
| | INTERVAL Fields that support total and |
| | interval values will display |
| | values calculated for the |
| | current statistics interval. |
| | This interval is defined by the |
| | StatInt parameter in the Gateway |
| | INI file. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,WebService,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The name of the job executing the CICS |
| | Transaction Gateway. |
| | |
| | This field will be highlighted if it matches |
| | the current target jobname. |
+------------------+--------------------------------------------------+
| WebService | The name of the web service. |
+------------------+--------------------------------------------------+
| InFlight | The current number of inflight web service |
| | transactions. These transactions might or might |
| | not be active in CICS. However, they represent |
| | one mirror transaction, which might be in a |
| | suspended state. |
| | |
| | Statistics ID: WSx_CREQ |
+------------------+--------------------------------------------------+
| Requests | The number of web service requests that have |
| | been processed. Successful and failed requests |
| | are included. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: WSx_LALLREQ/WSx_IALLREQ |
+------------------+--------------------------------------------------+
| ReqHWM | The high water mark of concurrent web service |
| | transactions that have been in flight at the |
| | same time. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: WSx_LREQHI/WSx_IREQHI |
+------------------+--------------------------------------------------+
| RespTime | The average time for the web service to respond |
| | to requests from remote clients. Successful and |
| | failed requests are included. This value |
| | includes the CICS server response time. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: WSx_LAVRESP/WSx_IAVRESP |
+------------------+--------------------------------------------------+
| ReqLen | The average amount of application request data |
| | received from clients. |
| | |
| | This field supports total and interval values. |
+------------------+--------------------------------------------------+
| RespLen | The average amount of application response data |
| | returned to clients. |
| | |
| | This field supports total and interval values. |
+------------------+--------------------------------------------------+
| ReqLenT | The total amount of application request data |
| | received from clients. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: WSx_LREQDATA/WSx_IREQDATA |
+------------------+--------------------------------------------------+
| RespLenT | The total amount of application response data |
| | returned to clients. |
| | |
| | This field supports total and interval values. |
| | |
| | Statistics ID: WSx_LRESPDATA/WSx_IRESPDATA |
+------------------+--------------------------------------------------+
| Server | The CICS server that requests to this web |
| | service are sent. |
| | |
| | Statistics ID: WSx_SSERVER |
+------------------+--------------------------------------------------+
| EIBTRNID | The CICS EIBTRNID transaction identifier for |
| | requests to this web service. |
| | |
| | Statistics ID: WSx_SEIBTRNID |
+------------------+--------------------------------------------------+
| Mirror | The name of the CICS mirror transaction under |
| | which requests to this web service run. |
| | |
| | Statistics ID: WSx_SMIRROR |
+------------------+--------------------------------------------------+
| Program | The name of the CICS program that implements |
| | this web service. |
| | |
| | Statistics ID: WSx_SPROGRAM |
+------------------+--------------------------------------------------+
| URI | The URI that requests to this web service are |
| | sent. |
| | |
| | Statistics ID: WSx_SURI |
+------------------+--------------------------------------------------+
| ASID | The hexadecimal address space ID executing |
| | the CICS Transaction Gateway. |
| | |
| | This field will be highlighted if it matches |
| | the current target ASID. |
+------------------+--------------------------------------------------+
| PID | The process ID in hexadecimal format of the CICS |
| | Transaction Gateway. |
| | |
| | This field will be highlighted if the ASID |
| | matches the current target ASID and the PID |
| | matches the current PID or the current PID is |
| | set to "*". |
+------------------+--------------------------------------------------+
| PIDD | The process ID in decimal format of the CICS |
| | Transaction Gateway. |
| | |
| | This field will be highlighted if the ASID |
| | matches the current target ASID and the PID |
| | matches the current PID or the current PID is |
| | set to "*". |
+------------------+--------------------------------------------------+
| TCB | The TCB of the CICS Transaction Gateway. |
+------------------+--------------------------------------------------+
| AgentTCB | The TCB of the data collector agent installed |
| | in the CICS Transaction Gateway. |
+------------------+--------------------------------------------------+
| SSID | The subsystem ID of the data collector agent. |
+------------------+--------------------------------------------------+
| Message | The message, if any, returned as the result of |
| | requesting information from the JVM data |
| | collector agent. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands
The following table lists the line commands defined by the
&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| OPTions | Alter the display by modifying profile options |
| | specific to this command. The values will be |
| | preserved in the profile. |
| | |
| | This subcommand accepts the following |
| | parameters: |
| | |
| | TOTAL Fields that support total and |
| | interval values will display |
| | values calculated since the CTG |
| | was successfully initialized. |
| | |
| | INTERVAL Fields that support total and |
| | interval values will display |
| | values calculated for the |
| | current statistics interval. |
| | This interval is defined by the |
| | StatInt parameter in the Gateway |
| | INI file. |
+------------------+--------------------------------------------------+
| REFresh | Refreshes the display data. |
+------------------+--------------------------------------------------+

Related Information

The data for this command requires the following:


* JVM component
* JVM Data Collector
* A SYSVIEW JVM data collector agent

Security Requirements

For security requirements, use the link: CTGWEBSV command security


CTIMERS

CTIMERS Command

The CTIMERS command displays information about CICS interval


control timers.

Command Syntax

+------------------+--------------------------------------------------+
| CTIMERS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| ExprDate | The date the timer expires. |
+------------------+--------------------------------------------------+
| ExprTime | The time the timer expires. |
+------------------+--------------------------------------------------+
| Remaining | The time remaining before the timer expires. |
+------------------+--------------------------------------------------+
| Interval | If present, the timer reinitializes itself upon |
| | expiration. |
+------------------+--------------------------------------------------+
| Domain | The name of the CICS domain owning the timer. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CTOGGLES

CTOGGLES Command

The CTOGGLES command displays CICS feature toggles and values.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTOGGLES | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Toggle,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Toggle | The name of the feature toggle. |
+------------------+--------------------------------------------------+
| Value | The value of the feature toggle. |
+------------------+--------------------------------------------------+
| Source | The source of the feature toggle. |
| | Possible values are: |
| | |
| | INTERNAL |
| | GROUP |
| | REGION |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined


by the RXDISP.&HelpMember command. Other types of
line commands are also available. Follow the links
below for more information.

Special Line Commands


External Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CTRACE

CTRACE Command

The CTRACE command display formats the CICS internal trace table.
The trace entries can be displayed in an abbreviated, short or
full format. Multiple formats can be selected.

Command Syntax

+------------------+--------------------------------------------------+
| CTRACE | [ REGion | SYStem ] |
| | [ Local | Global ] |
| | |
| | [ GROUP name ] |
| | |
| | [ Abbrev ] [ Short ] [ Full ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| Local | |
+------------------+--------------------------------------------------+
| SYStem | Display all CICS address spaces currently being |
| Global | monitored on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| Abbrev | Specifies that the format routine is to display |
| | one line per trace entry. |
| | This is the default. |
+------------------+--------------------------------------------------+
| Short | Specifies that you require the short |
| | formatted print of the data in each entry. |
| | This consists of the information in the |
| | abbreviated format entry, and the following |
| | elements from the interpretation string of the |
| | fully formatted entry: |
| | * Interpreted parameter list |
| | * Return address |
| | * Time |
| | * Interval |
+------------------+--------------------------------------------------+
| Full | Specifies that you want a fully formatted print |
| | of all data in each entry. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+
| Size | Specifies the size of the CICS internal |
| | trace table. |
+------------------+--------------------------------------------------+
| Main | Specifies if the CICS main trace flag is |
| | active. |
+------------------+--------------------------------------------------+
| Internal | Specifies whether the internal CICS trace |
| | destination is active. |
+------------------+--------------------------------------------------+
| GTF | Specifies whether CICS is to use GTF as a |
| | destination for CICS trace data. |
+------------------+--------------------------------------------------+
| AuxTrace | Specifies whether the CICS auxiliary trace |
| | destination is active. |
| | Possible values: |
| | STARTED |
| | STOPPED |
| | PAUSED |
+------------------+--------------------------------------------------+
| AuxSwitch | Specifies how the CICS auxiliary trace |
| | autoswitch facility will operate. |
| | Possible values: |
| | OFF - Autoswitch is disabled |
| | ONCE - The autoswitch facility will |
| | switch to the next data set |
| | at end of file of the first |
| | data set used for auxiliary |
| | trace. The switch will only |
| | occur once. |
| | CONTINUOUS - Enables the autoswitch facility |
| | to switch to the inactive data |
| | set at every end of file. |
| | Whenever a data set is full, |
| | it is closed and the other |
| | data set is opened. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Specifies the owning CICS jobname of the |
| | originating trace entry. |
+------------------+--------------------------------------------------+
| Formatted-Trace | Displays the formatted trace entry. |
+------------------+--------------------------------------------------+
| Time | Specifies the time of day for the trace entry. |
+------------------+--------------------------------------------------+
| Task# | Specifies the CICS task number or ID. |
+------------------+--------------------------------------------------+
| TCBID | Specifies the CICS TCB ID. |
+------------------+--------------------------------------------------+
| Dm | Specifies CICS domain name that created the |
| | trace entry. |
+------------------+--------------------------------------------------+
| Id | Specifies trace ID. |
+------------------+--------------------------------------------------+
| KE | Specifies the kernel task number. |
+------------------+--------------------------------------------------+
| Own | Specifies the owning kernel task number is |
| | trace entry is from a system task. |
+------------------+--------------------------------------------------+
| TCB | Specifies the address of the TCB that created |
| | the trace entry. |
+------------------+--------------------------------------------------+
| R14 | Specifies the return address. |
+------------------+--------------------------------------------------+
| Type | Specifies the trace entry type. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| * | Display the selected trace entry using all |
| | formats. |
+------------------+--------------------------------------------------+
| A+ | Display the selected trace entry using the |
| | abbreviated format in addition to existing |
| | formats. |
+------------------+--------------------------------------------------+
| F+ | Display the selected trace entry using the |
| | full format in addition to existing formats. |
+------------------+--------------------------------------------------+
| S+ | Display the selected trace entry using the |
| | short format in addition to existing formats. |
+------------------+--------------------------------------------------+
| Abbrev | Display the selected trace entry using the |
| | abbreviated format. |
+------------------+--------------------------------------------------+
| Full | Display the selected trace entry using the |
| | full format. |
+------------------+--------------------------------------------------+
| Reset | Display the selected trace entry using the |
| | format specified at command invocation. |
+------------------+--------------------------------------------------+
| Short | Display the selected trace entry using the |
| | short format. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CTRANCAN

CTRANCAN Command

The CTRANCAN command is used to display and maintain a single set


of transaction cancel definitions that are used for all CICS
regions being monitored by SYSVIEW on the current system.

Definitions can be added or maintained here (warm start) or


in parmlib member CTRANCAN (cold start).

The SYSVIEW for CICS data collector can perform the following
transaction cancellation functions:

* Transaction cancellation at CICS shutdown or termination

It is common for CICS shutdown to be delayed due to a


conversational transaction waiting on terminal input.

A definition can be created to cancel a transaction at


shutdown based on the following transaction attributes:

* Transaction ID
* Jobname
* Facility name
o Terminal
o Transient data queue
* Wait reason - Suspend Type
* Wait reason - Suspend value

If you create definitions for long-running transactions,


CICS can terminate quickly since you are not forced to
wait for these transactions to complete.

Transaction cancellation at CICS shutdown requires the


following CICS configuration option to be specified in
parmlib member SVWCOPTS.

Configuration-Option Value
-------------------------------- -----
TRANSACTION-CANCEL-AT-SHUTDOWN YES

* Transaction Cancellation based on Exception Definitions

CICS transactions can be automatically cancelled based on a


threshold exception definition. Threshold exception
definitions can be viewed or modified using command
RULES CICS

Transaction cancellation can be overridden or excluded


based on the current wait reason of the transaction.

If it is determined that the transaction is currently abending,


a transaction cancellation will not be attempted.

The cancellation definitions are based on the following:


* Transaction ID
* Facility name (terminal, transient data queue)
* Suspend Type
* Suspend value

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTRANCAN | [ function [ parameters ] ] |
| | |
| +--------------------------------------------------+
| | |
| | Function Parameters |
| | ----------- ------------------------------------ |
| | ADDLINE |
| | NOADDLINE |
| | |
| | ADD |
| | |
| | DELETE tran jobname facility |
| | susptype suspvalue |
| | |
| | EMPTY |
| | |
| | EXPORT dataset.name(member) |
| | |
| | LOAD member |
| | |
| | RELOAD [ blank | * | WARM ] |
| | [ member ] |
| | [ DATALIB ] |
| | [ COLD ] |
| | |
| | SAVE |
| | |
+------------------+--------------------------------------------------+

If SELECT is used with this command, the dummy input line for adding
new definitions always displays. The dummy add line is being excluded
from the select process.

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| ADDLINE | Specify whether the "?Add" data line should |
| NOADDLINE | be displayed. |
| | |
| | The "?Add" line can be used to create a new |
| | definition. It may be desirable to exclude the |
| | "?Add" data line when the data is being |
| | displayed using a non-3270 interface. |
| | |
+------------------+--------------------------------------------------+
| ADD | Add new definition. |
| | A full screen input panel will be displayed. |
| | |
| | Syntax: CTRANCAN ADD |
| | |
+------------------+--------------------------------------------------+
| DELETE | Delete an existing definition. |
| | |
| | Parameters: |
| | tran - transaction ID |
| | jobname - CICS jobname |
| | facility - facility name |
| | suspt - wait reason suspend type |
| | suspv - wait reason suspend value |
| | |
| | Syntax: CTRANCAN DELETE tran jobname facility |
| | suspt suspv |
| | |
+------------------+--------------------------------------------------+
| EMPTY | Delete all existing definitions. |
+------------------+--------------------------------------------------+
| LOAD | Load definitions. |
| | |
| | Existing definitions will NOT be deleted. |
| | |
| | member - Load definitions from the |
| | specified parmlib member. |
| | |
+------------------+--------------------------------------------------+
| RELOAD | Reload definitions. |
| | |
| | Existing definitions will be deleted. |
| | |
| | * - Reload definitions from the |
| | blank persistent data store. If the |
| | WARM object is not found in the |
| | persistent data store, reload |
| | the definitions from parmlib. |
| | |
| | The parmlib member to be used |
| | is: CTRANCAN |
| | |
| | DATALIB - Reload definitions from the |
| | persistent data store. |
| | |
| | COLD - Reload definitions from parmlib. |
| | |
| | member - Reload definitions from the |
| | specified parmlib member. |
| | |
+------------------+--------------------------------------------------+
| EXPORT | Exports definitions to a specific member of |
| | a data set. |
| | |
| | Syntax: EXPORT member |
| | dsname(member) |
| | |
| | Parameter Description |
| | ---------- --------------------------------- |
| | member The name of the member to be |
| | saved. |
| | |
| | dsname The data set name where the |
| | specified member is saved. |
| | |
| | The data set name can be |
| | specified as a fully qualified |
| | data set name or using one of the |
| | following special keywords: |
| | |
| | Keyword Description |
| | ---------- ------------------------------- |
| | USER Uses the optional data set name |
| | defined in the user profile |
| | for the library type PARMLIB. |
| | |
| | Example: USER(member) |
| | |
| | SITE Uses the optional site PARMLIB |
| | data set that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITE(member) |
| | |
| | SYSTEM Uses the system PARMLIB data set |
| | that is defined in the system |
| | configuration options parmlib |
| | member: GSVXGSVX |
| | |
| | Example: SYSTEM(member) |
| | |
| | SITESYSTEM Uses the first defined data |
| | SITE.SYSTEM set from the following list |
| | * of eligible data set names: |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITESYSTEM(member) |
| | SITE.SYSTEM(member) |
| | *(member) |
| | |
| | USERSITE Uses the first defined data |
| | USER.SITE set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSITE(member) |
| | USER.SITE(member) |
| | |
| | USERSYSTEM Uses the first defined data |
| | USER.SYSTEM set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSYSTEM(member) |
| | USER.SYSTEM(member) |
| | |
| | The above keywords can be cursor selected |
| | invoking a hyperlink to the PARMLIB command |
| | showing the available data sets for the |
| | keyword. |
| | |
+------------------+--------------------------------------------------+
| SAVE | Save the definitions to the persistent data |
| | store. |
| | |
| | The definitions will be stored using a |
| | DataID = "CTRANCAN". |
| | |
| | Persistent store DATALIB list |
| | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | Specifies the definitions are system wide. |
| | The definitions are used by all CICS regions |
| | on the current system. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Tran | The CICS transaction ID. |
| | |
| | The transaction ID can be specified as: |
| | |
| | * Specific transaction ID |
| | * Generic transaction ID |
| | * Logical group name containing a list of |
| | CICS transactions. |
| | Logical group type = CICSTRAN |
| | Syntax: ]group |
| | |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname to which the definition is |
| | to be applied. |
| | |
| | The jobname can be specified as: |
| | |
| | * Specific CICS jobname |
| | * Generic CICS jobname |
| | * Logical group name containing a list of |
| | CICS jobnames. |
| | Logical group type = CICSPLEX |
| | Syntax: ]group |
| | |
+------------------+--------------------------------------------------+
| Facility | Facility name |
| | |
| | DEST - Transient data queue name |
| | TERM - Terminal ID |
| | TASK - = |
+------------------+--------------------------------------------------+
| SuspType | CICS wait reason suspend type |
| | See "resource type" details in the |
| | CICS Problem Determination Guide. |
+------------------+--------------------------------------------------+
| SuspValue | CICS wait reason suspend value |
| | See "resource value" details in the |
| | CICS Problem Determination Guide. |
+------------------+--------------------------------------------------+
| Dynamic | The dynamic cancellation method |
| | |
| | If the threshold definition specified the |
| | transaction cancellation type as AUTO, |
| | the cancellation type will be determined |
| | based on this option. |
| | |
| | Valid values are: |
| | |
| | NOCANCEL - Do not dynamically cancel |
| | transaction. |
| | |
| | PURGE - Purge the transaction. |
| | |
| | Method: |
| | |
| | CEKL SET TASK(number) PURGE |
| | |
| | FORCEPUR - Force purge the transaction. |
| | |
| | Method: |
| | |
| | CEKL SET TASK(number) FORCEPURGE |
| | |
| | CANCEL - Cancel the transaction. |
| | |
| | Progressive methods: |
| | |
| | CEKL SET TASK(number) PURGE |
| | |
| | If task still exists then |
| | CEKL SET TASK(number) FORCEPURGE|
| | |
| | KILL - Kill the transaction. |
| | |
| | Progressive methods: |
| | |
| | CEKL SET TASK(number) PURGE |
| | |
| | If task still exists then |
| | CEKL SET TASK(number) FORCEPURGE|
| | |
| | If task still exists then |
| | CEKL SET TASK(number) KILL |
| | |
| | CKILL - Kill the transaction. |
| | |
| | Method: |
| | |
| | CEKL SET TASK(number) KILL |
| | |
+------------------+--------------------------------------------------+
| Shutdown | Specifies whether a matching transaction |
| | is to be canceled during CICS shutdown. |
| | |
| | Valid values are: |
| | |
| | SHUTDOWN - A transaction matching the |
| | definition will be automatically |
| | canceled during CICS shutdown. |
| | NOSHUTDOWN - A transaction matching the |
| | definition will not be canceled |
| | during CICS shutdown. |
| | |
+------------------+--------------------------------------------------+
| MatchJob | Indicates whether the definition matches the |
| | current target jobname. |
| | |
| | Possible values are: |
| | |
| | YES - The definition applies to or matches |
| | the current target jobname. |
| | |
| | blanks - The definition does not apply to or |
| | match the current target jobname. |
| | |
| | If the current target jobname |
| | displayed in the information section |
| | is not a monitored CICS jobname, |
| | "blanks" will also be displayed. |
| | |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Add | Add a new definition |
+------------------+--------------------------------------------------+
| Copy | Copy the definition attributes and create a |
| | new definition. |
+------------------+--------------------------------------------------+
| DELete | Delete the selected definition. |
+------------------+--------------------------------------------------+
| Edit | Edit the selected definition. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Group | Display CICS logical group definitions. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| ADD | Add new definition. |
| | |
| | Syntax: ADD |
| | |
+------------------+--------------------------------------------------+
| DELETE | Delete an existing definition. |
| | |
| | Parameters: |
| | tran - transaction ID |
| | jobname - CICS jobname |
| | facility - facility name |
| | suspt - wait reason suspend type |
| | suspv - wait reason suspend value |
| | |
| | Syntax: DELETE tran jobname facility |
| | suspt suspv |
| | |
+------------------+--------------------------------------------------+
| EMPTY | Delete all existing definitions. |
| | |
| | Syntax: EMPTY |
| | |
+------------------+--------------------------------------------------+
| LOAD | Load definitions. |
| | |
| | Existing definitions will NOT be deleted. |
| | |
| | Syntax: LOAD member |
| | |
| | member - Load definitions from the |
| | specified parmlib member. |
| | |
+------------------+--------------------------------------------------+
| RELOAD | Reload definitions. |
| | |
| | Existing definitions will be deleted. |
| | |
| | Syntax: RELOAD member |
| | |
| | * - Reload definitions from the |
| | blank persistent data store. If the |
| | WARM object is not found in the |
| | persistent data store, reload |
| | the definitions from parmlib. |
| | |
| | The parmlib member to be used |
| | is: CTRANCAN |
| | |
| | DATALIB - Reload definitions from the |
| | persistent data store. |
| | |
| | COLD - Reload definitions from parmlib. |
| | |
| | member - Reload definitions from the |
| | specified parmlib member. |
| | |
+------------------+--------------------------------------------------+
| EXPORT | Exports definitions to a specific member of |
| | a data set. |
| | |
| | Syntax: EXPORT member |
| | dsname(member) |
| | |
| | Parameter Description |
| | ---------- --------------------------------- |
| | member The name of the member to be |
| | saved. |
| | |
| | dsname The data set name where the |
| | specified member is saved. |
| | |
| | The data set name can be |
| | specified as a fully qualified |
| | data set name or using one of the |
| | following special keywords: |
| | |
| | Keyword Description |
| | ---------- ------------------------------- |
| | USER Uses the optional data set name |
| | defined in the user profile |
| | for the library type PARMLIB. |
| | |
| | Example: USER(member) |
| | |
| | SITE Uses the optional site PARMLIB |
| | data set that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITE(member) |
| | |
| | SYSTEM Uses the system PARMLIB data set |
| | that is defined in the system |
| | configuration options parmlib |
| | member: GSVXGSVX |
| | |
| | Example: SYSTEM(member) |
| | |
| | SITESYSTEM Uses the first defined data |
| | SITE.SYSTEM set from the following list |
| | * of eligible data set names: |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITESYSTEM(member) |
| | SITE.SYSTEM(member) |
| | *(member) |
| | |
| | USERSITE Uses the first defined data |
| | USER.SITE set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSITE(member) |
| | USER.SITE(member) |
| | |
| | USERSYSTEM Uses the first defined data |
| | USER.SYSTEM set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSYSTEM(member) |
| | USER.SYSTEM(member) |
| | |
| | The above keywords can be cursor selected |
| | invoking a hyperlink to the PARMLIB command |
| | showing the available data sets for the |
| | keyword. |
| | |
+------------------+--------------------------------------------------+
| SAVE | Save the definitions to the persistent data |
| | store. |
| | |
| | The definitions will be stored using a |
| | DataID = "CTRANCAN". |
| | |
| | Persistent store DATALIB list |
| | |
| | Syntax: SAVE |
| | |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Cancel Transactions at Shutdown

A definition can specify a transaction that is to be automatically


canceled by SYSVIEW during CICS shutdown. It is common for CICS
shutdown to be delayed due to a conversational transaction waiting on
terminal input. If you define long-running transactions to this
facility, CICS can terminate quickly since you are not forced to wait
for these transactions to complete.

Dynamic Transaction Cancellation

CICS transactions can be automatically canceled based on a threshold


exception definition. Threshold definitions are maintained using
the RULES CICS THRESH command. The transaction cancel definition provides
the following functions:

* Exclude transaction from being dynamically cancelled


* Determine cancellation method or strength based on current wait
reason

If it is determined that the transaction is currently abending,


a transaction cancellation will not be attempted.
CTRANDEG

CTRANDEG Command

The CTRANDEG command displays degradation analysis for transactions to


summarize the time spent by CICS on various execution and wait reasons.

The information is shown for all transactions grouped together,


a unique transaction, and by defined transaction groups.

Transaction resource usage is evaluated based on current threshold


definitions.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTRANDEG | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
| | [ TOTal | SYSInterval | INTerval ] |
| | |
| | [ STATUS | NOSTATUS ] |
| | |
| | [ GRPSONLY ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
| TOTal | Request analysis of data since data collection |
| | was last started. |
+------------------+--------------------------------------------------+
| SYSInterval | Request analysis of data for the current |
| | system interval. |
+------------------+--------------------------------------------------+
| INTerval | Request analysis of data for the current 60 |
| | second interval. |
+------------------+--------------------------------------------------+
| STATus | Evaluate data fields against threshold |
| | definitions. Metric data fields will be |
| | displayed using conditional status. |
| | |
| | Status is not shown for system transactions. |
+------------------+--------------------------------------------------+
| NOSTATus | Do not evaluate data fields against threshold |
| | definitions. |
+------------------+--------------------------------------------------+
| GRPSONLY | Display only transaction group entries. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields
Default Sort Order: XSSystem,A,Jobname,A,Tran,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Tran | Transaction ID or group |
+------------------+--------------------------------------------------+
| Count | The number of transactions that have executed |
| | since the start of data collection. |
+------------------+--------------------------------------------------+
| Abends | The number of transaction abends. |
+------------------+--------------------------------------------------+
| LIFETIME | Life time of transaction |
| | |
| | Status will not be evaluated for long running |
| | transactions. |
+------------------+--------------------------------------------------+
| Exec% | The percentage of life time where the |
| | transaction was executing or dispatchable. |
+------------------+--------------------------------------------------+
| Wait% | The percentage of life time where the |
| | transaction was waiting or suspended. |
+------------------+--------------------------------------------------+
| CPUTIME | CPU time used by transaction |
+------------------+--------------------------------------------------+
| KY8CPUT | CPU time - K8 TCB |
+------------------+--------------------------------------------------+
| KY9CPUT | CPU time - K9 TCB |
+------------------+--------------------------------------------------+
| L8CPUT | CPU time - L8 TCB |
+------------------+--------------------------------------------------+
| L9CPUT | CPU time - L9 TCB |
+------------------+--------------------------------------------------+
| MSCPUT | CPU time - MS TCB |
+------------------+--------------------------------------------------+
| QRCPUT | CPU time - QR TCB |
+------------------+--------------------------------------------------+
| RLSCPUT | CPU time - RLS file requests |
+------------------+--------------------------------------------------+
| ROCPUT | CPU time - RO TCB |
+------------------+--------------------------------------------------+
| S8CPUT | CPU time - S8 TCB |
+------------------+--------------------------------------------------+
| T8CPUT | CPU time - T8 TCB |
+------------------+--------------------------------------------------+
| X8CPUT | CPU time - X8 TCB |
+------------------+--------------------------------------------------+
| X9CPUT | CPU time - X9 TCB |
+------------------+--------------------------------------------------+
| CPUTONCP | CPU time on standard CP |
+------------------+--------------------------------------------------+
| OFFLCPUT | Offload on standard CP |
+------------------+--------------------------------------------------+
| DISPTIME | Dispatch time |
+------------------+--------------------------------------------------+
| KY8DISPT | Dispatch time - K8 TCB |
+------------------+--------------------------------------------------+
| KY9DISPT | Dispatch time - K9 TCB |
+------------------+--------------------------------------------------+
| MSDISPT | Dispatch time - MS TCB |
+------------------+--------------------------------------------------+
| QRDISPT | Dispatch time - QR TCB |
+------------------+--------------------------------------------------+
| RODISPT | Dispatch time - RO TCB |
+------------------+--------------------------------------------------+
| WMQASRBT | MQ API SRB time |
+------------------+--------------------------------------------------+
| SYNCTIME | Syncpoint dispatch time |
+------------------+--------------------------------------------------+
| PCPLTIME | Program load time |
+------------------+--------------------------------------------------+
| SUSPTIME | Suspend time |
+------------------+--------------------------------------------------+
| ASFTCHWT | Asynchronous FETCH wait time |
+------------------+--------------------------------------------------+
| ASRNATWT | Asynchronous RUN delayed time |
+------------------+--------------------------------------------------+
| RUNTRWTT | CBTS run process/activity sync wait |
+------------------+--------------------------------------------------+
| SRVSTWTT | CFDT server syncpoint wait time |
+------------------+--------------------------------------------------+
| CFDTWAIT | CFDT I/O wait time |
+------------------+--------------------------------------------------+
| EXWTIME | CICS exception wait time |
+------------------+--------------------------------------------------+
| WTCEWAIT | CICS ECB wait time |
+------------------+--------------------------------------------------+
| JVMITIME | CICS JVM initialize elapse time |
+------------------+--------------------------------------------------+
| JVMRTIME | CICS JVM reset elapse time |
+------------------+--------------------------------------------------+
| MAXOTDLY | CICS MAXOPENTCBS delay time |
+------------------+--------------------------------------------------+
| DSCHMDLY | CICS TCB Change Mode delay time |
+------------------+--------------------------------------------------+
| DSPDELAY | Dispatch delay time - 1st |
+------------------+--------------------------------------------------+
| DB2CONWT | DB2 Connection wait time |
+------------------+--------------------------------------------------+
| DB2RDYQW | DB2 Readyq wait time |
+------------------+--------------------------------------------------+
| DSAPTHWT | DS allocate pthread wait time |
+------------------+--------------------------------------------------+
| WTEXWAIT | External ECB wait time |
+------------------+--------------------------------------------------+
| ENQDELAY | ENQ delay - Task Control ENQ |
+------------------+--------------------------------------------------+
| FCPTIME | File I/O wait time |
+------------------+--------------------------------------------------+
| FCXCWTT | FC exclusive control wait time |
+------------------+--------------------------------------------------+
| FCVSWTT | FC VSAM string wait time |
+------------------+--------------------------------------------------+
| SZWAIT | FEPI elapsed time - time |
+------------------+--------------------------------------------------+
| GVUPWAIT | Give up control wait time |
+------------------+--------------------------------------------------+
| GNQDELAY | Global ENQ delay time |
+------------------+--------------------------------------------------+
| SOIOWTT | Inbound socket I/O wait time |
+------------------+--------------------------------------------------+
| MROTIME | Inter-region wait time |
+------------------+--------------------------------------------------+
| ICDELAY | Interval control delay wait time |
+------------------+--------------------------------------------------+
| IMSWAIT | IMS (DBCTL) wait time |
+------------------+--------------------------------------------------+
| ISALWTT | IS alloc wait time |
+------------------+--------------------------------------------------+
| ISIOWTT | IS I/O wait time |
+------------------+--------------------------------------------------+
| JVMSUSP | JVM suspend time |
+------------------+--------------------------------------------------+
| JVMTIME | JVM elapsed time |
+------------------+--------------------------------------------------+
| JCPTIME | Journal I/O wait time |
+------------------+--------------------------------------------------+
| JVMTHDWT | JVMSERVER thread wait time |
+------------------+--------------------------------------------------+
| LMDELAY | Lock manager delay wait time |
+------------------+--------------------------------------------------+
| LU61WTT | LU6.1 wait time |
+------------------+--------------------------------------------------+
| LU62WTT | LU6.2 wait time |
+------------------+--------------------------------------------------+
| WMQGETWT | MQ Getwait wait time |
+------------------+--------------------------------------------------+
| DSMMSCWT | MVS storage constraint wait time |
+------------------+--------------------------------------------------+
| MXTDELAY | MXT delay 1st dispatch |
+------------------+--------------------------------------------------+
| SOOIOWTT | Outbound socket I/O wait time |
+------------------+--------------------------------------------------+
| OTSINDWT | OTS indoubt wait time |
+------------------+--------------------------------------------------+
| RQPWAIT | Request processor wait time |
+------------------+--------------------------------------------------+
| RQRWAIT | Request receiver wait time |
+------------------+--------------------------------------------------+
| RMITIME | Resource Manager Interface |
+------------------+--------------------------------------------------+
| RMISUSP | Resource Manager Suspend |
+------------------+--------------------------------------------------+
| RLSWAIT | RLS wait time - time |
+------------------+--------------------------------------------------+
| RRMSWAIT | RRMS/MVS wait time |
+------------------+--------------------------------------------------+
| SYNCDLY | Syncpoint delay time |
+------------------+--------------------------------------------------+
| TSSHWAIT | Temp storage shared wait time |
+------------------+--------------------------------------------------+
| TSPTIME | Temp storage wait time |
+------------------+--------------------------------------------------+
| TERMTIME | Terminal I/O wait time |
+------------------+--------------------------------------------------+
| TCLDELAY | Tran class delay 1st disp |
+------------------+--------------------------------------------------+
| TDATTIME | Transient data request time |
+------------------+--------------------------------------------------+
| TCALWTT | TC alloc wait time |
+------------------+--------------------------------------------------+
| MAXTTDLY | TCB delay time - Max thread |
+------------------+--------------------------------------------------+
| MAXSTDLY | TCB delay time - Max SSL |
+------------------+--------------------------------------------------+
| MAXXTDLY | TCB delay time - Max XPLink |
+------------------+--------------------------------------------------+
| DSTCBMWT | TCB mismatch wait time |
+------------------+--------------------------------------------------+
| ROMODDLY | TCB Delay time - RO |
+------------------+--------------------------------------------------+
| SOMODDLY | TCB Delay time - SO |
+------------------+--------------------------------------------------+
| TDELWTT | TD extra lock wait time |
+------------------+--------------------------------------------------+
| TDILWTT | TD intra lock wait time |
+------------------+--------------------------------------------------+
| PTPWAIT | 3270 bridge partner wait time |
+------------------+--------------------------------------------------+
| WBURIOPN | WEB OPEN elapsed time |
+------------------+--------------------------------------------------+
| WBSVINVK | INVOKE SERVICE elapsed time |
+------------------+--------------------------------------------------+
| WBURIRCV | WEB RECEIVE SESSTOKEN elapsed time |
+------------------+--------------------------------------------------+
| WBURISND | WEB SEND SESSTOKEN elapsed time |
+------------------+--------------------------------------------------+
| XSVFYBAS | The total elapsed time that the user task spent |
| | verifying basic authentication tokens. |
+------------------+--------------------------------------------------+
| XSVFYJWT | The total elapsed time that the user task spent |
| | verifying JSON web tokens. |
+------------------+--------------------------------------------------+
| XSVFYKER | The total elapsed time that the user task spent |
| | verifying Kerberos tokens. |
+------------------+--------------------------------------------------+
| XSVFYPWD | The total elapsed time that the user task spent |
| | verifying passwords, password phrases, |
| | PassTickets and MFA tokens. |
+------------------+--------------------------------------------------+
| SMMVSSWT | The total elapsed time that the task spent |
| | waiting for z/OS storage. |
+------------------+--------------------------------------------------+
| RMITOTAL | RMI time - Total |
+------------------+--------------------------------------------------+
| RMICPSM | RMI time - CICSPlex SM |
+------------------+--------------------------------------------------+
| RMIDBCTL | RMI time - DBCTL |
+------------------+--------------------------------------------------+
| RMIDB2 | RMI time - DB2 |
+------------------+--------------------------------------------------+
| RMIEXDLI | RMI time - EXEC DLI |
+------------------+--------------------------------------------------+
| RMIMQM | RMI time - MQ |
+------------------+--------------------------------------------------+
| RMIOTHER | RMI time - Other |
+------------------+--------------------------------------------------+
| RMITCPIP | RMI time - TCP/IP sockets |
+------------------+--------------------------------------------------+
| WTRTIME | Waiting to run time |
+------------------+--------------------------------------------------+
| QRMODDLY | Wait for dispatch - QR TCB |
+------------------+--------------------------------------------------+
| GSVITIME | SYSVIEW global user exit monitor time |
+------------------+--------------------------------------------------+
| GSVICPU | SYSVIEW global user exit cpu time |
+------------------+--------------------------------------------------+
| MONXTIME | SYSVIEW monitor exit interface time |
+------------------+--------------------------------------------------+
| MONXCPU | SYSVIEW monitor exit interface CPU time |
+------------------+--------------------------------------------------+
| CSFXTIME | SYSVIEW CSF exit interface time |
+------------------+--------------------------------------------------+
| CSFXCPU | SYSVIEW CSF exit interface CPU time |
+------------------+--------------------------------------------------+
| Elapsed | Elapsed time since last execution |
+------------------+--------------------------------------------------+
| System | Indicates the transaction is a system |
| | transaction. |
+------------------+--------------------------------------------------+
| RowStat | Overall row condition status |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Life | Invokes the CLIFE command to show lifetime ranges|
| | and analysis for the selected transaction. |
+------------------+--------------------------------------------------+
| Proguse | Invokes the CPROGUSE command to show program |
| | usage for the selected transaction. |
+------------------+--------------------------------------------------+
| Select | Invokes the CWAITS command to show degradation |
| | analysis for the selected transaction. |
+------------------+--------------------------------------------------+
| CTRANLOG | Invokes the CTRANLOG command to display the |
| TL | selected jobname and transactions that executed |
| | within the previous 1 day. |
+------------------+--------------------------------------------------+
| CTRANSUM | Invokes the CTRANSUM command to display the |
| TS | selected jobname and transactions that executed |
| | within the previous 1 day. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CTRANLOG

CTRANLOG Command

The CTRANLOG command displays CICS transaction records.

The CTRANLOG command displays a list of the CICS transaction detail


records that have been logged to an MVS log stream. A record is a
historical view into the resource usage and actions performed by
a CICS transaction.

A log can potentially contain a very large number of records. For


this reason, only the specified number of records will be displayed.
This set of records is referred to as the "display window", and is
controlled by the LINES parameter on the command or the LINES
parameter on the OPTIONS subcommand.

Command Syntax

+------------------+--------------------------------------------------+
| | |
| &HelpMember | [ STREAM logstream ] |
| | |
| | [ DATE * | date ] |
| | [ TIME * | time ] |
| | |
| | [ READNext ] |
| | [ READPrev ] |
| | |
| | [ PERiod hh:mm:ss ] |
| | [ CUSHion hh:mm:ss ] |
| | |
| | [ LINEs datalines ] |
| | [ LIMit readlimit ] |
| | [ ELAPsedlimit hh:mm:ss ] |
| | |
| | [ RECtime END | START ] |
| | |
| | [ DISCARD ] |
| | [ NODISCARD ] |
| | |
| | [ FILTER ] |
| | [ NOFILTER ] |
| | |
| | [ GROUP group ] |
| | [ JOBName jobname ] |
| | [ TRAN tran ] |
| | [ OTRAN tran ] |
| | [ PROGRAM program ] |
| | [ TERMinal terminal ] |
| | [ USERid userid ] |
| | [ UMBRELLA umbrella ] |
| | [ UMBTYPE umbtype ] |
| | [ DEFGROUP group ] |
| | [ ABND abendcode ] |
| | [ CLIENT client ] |
| | [ EITRACE name ] |
| | [ WEBSERVICE webservice ] |
| | [ URIPath uripath ] |
| | [ FILEname filename ] |
| | [ DB2 db2ssid ] |
| | [ QMGR qmgr ] |
| | [ MQQueue queue ] |
| | |
| | [ LIFETIME oper time ] |
| | [ CPUTIME oper time ] |
| | [ IOREQS oper count ] |
| | [ XCT oper count ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| STREAM logstream | Specifies the log stream name from which to |
| | display data. |
| | |
| | If no log stream name is specified, the parmlib |
| | member LGLOOKUP will be used to locate a |
| | matching log stream name. |
| | |
| | Use the following "short" names to substitute |
| | the default log stream name for the indicated |
| | record type: |
| | |
| | AUDIT - Audit events |
| | CICSEITL - CICS EXEC interface trace log |
| | CICSSYSD - CICS system interval analysis |
| | CICSTRAN - CICS transaction log |
| | CICSTSUM - CICS transaction summary log |
| | CICSXLOG - CICS exception log |
| | CTGLOG - CICS Transaction Gateway log |
| | IMSIMTR - IMS transaction log |
| | IMSIMRS - IMS region summary log |
| | IMSIMTS - IMS transaction summary log |
| | IMSOMAT - IMS OM audit trail log |
| | MQSDATA - MQ request history log |
| | OPERLOG - Operations log stream |
| | PLOTLOG - Historical plot log |
| | SMFDATA - SMF log |
| | XLOG - Exception log |
| | ZCNRLOG - z/OS Connect request log |
| | |
+------------------+--------------------------------------------------+
| DATE date | Position to specified date in log. |
| | Read records from the starting point in a |
| | forward direction ( youngest to newest ). |
| | |
| | date - The date value must be specified |
| | using the date format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | Query current date format |
| | |
| | * - Use the current date (today). |
| | |
| | -days - Position to today's date |
| | minus the specified number |
| | of days. |
| | |
| | If a DATE value is supplied and a TIME |
| | value is not supplied, the current TIME (now) |
| | will be used. |
| | |
+------------------+--------------------------------------------------+
| TIME time | Position to specified time in log. |
| | |
| | time - The time value must be specified |
| | using the time format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | Query current time format |
| | |
| | * - Use the current time (now). |
| | |
| | nnAM - The time value can also be |
| | nnPM specified using one of the |
| | following values: |
| | 12AM | 1AM | 2AM | ... | 11AM |
| | 12PM | 1PM | 2PM | ... | 11PM |
| | NOON | MIDNIGHT |
| | |
| | -adjust - Set the time value to the |
| | +adjust current time (now) plus or minus |
| | the specified adjustment value. |
| | |
| | Example adjustment values: |
| | |
| | -0.500000 - 0.5 seconds |
| | -60 - 60 seconds |
| | -120Sec - 120 seconds |
| | -5MINutes - 5 minutes |
| | -1Hours - 1 hour |
| | -1Days - 1 day |
| | -hh:mm:ss - hours:minutes:seconds |
| | |
| | +0.500000 + 0.5 seconds |
| | +60 + 60 seconds |
| | +120Sec + 120 seconds |
| | +5MINutes + 5 minutes |
| | +1Hours + 1 hour |
| | +1Days + 1 day |
| | +hh:mm:ss + hours:minutes:seconds |
| | |
| | If a TIME value is supplied and a DATE |
| | value is not supplied, the current DATE |
| | will be used. |
| | |
+------------------+--------------------------------------------------+
| READPrev | If a date or time value is specified, READPREV |
| | specifies that the log is to be read starting |
| | at the date and time and read backwards |
| | (youngest to oldest). |
| | |
| | If date or time is not specified, the READPREV |
| | parameter is ignored. |
| | |
+------------------+--------------------------------------------------+
| READNext | If a date or time value is specified, READNEXT |
| | specifies that the log is to be read starting |
| | at the date and time and read forwards |
| | (oldest to youngest). |
| | |
| | If date or time is not specified, the READNEXT |
| | parameter is ignored. |
| | |
+------------------+--------------------------------------------------+
| PERiod hh:mm:ss | Specifies the time period for which records are |
| | to be displayed. |
| | |
| | Default : 0 (unlimited) |
| | |
| | Example values: |
| | |
| | NONE - No period (unlimited) |
| | 0 - No period (unlimited) |
| | 0.500000 - 0.5 seconds |
| | 60 - 60 seconds |
| | 120Sec - 120 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | 1Days - 1 day |
| | 1MONths - 1 month |
| | 1Years - 1 year |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| CUSHion hh:mm:ss | Specifies the time period cushion for which |
| | records are to be read for display. |
| | |
| | Data records stored in an MVS log stream are |
| | sequenced or sorted based on the actual time |
| | the record was written to the stream. |
| | |
| | This does not guarantee that the records are |
| | sorted in a time sequence based on the |
| | date and time information that is potentially |
| | contained within each record. |
| | |
| | For this reason, when a user wants to display |
| | a specific time period of data, additional |
| | records must be read on the front and back |
| | end of the read process to ensure that the |
| | records that might be out of sequence are |
| | included. |
| | |
| | The time period cushion specifies the extra |
| | records to be read. |
| | |
| | Example Cushion: |
| | |
| | Start time: 8AM |
| | Period : 1 Hour |
| | Cushion : 5 minutes |
| | |
| | Read Begin : 07:55:00 |
| | -- Discard records |
| | Display Begin : 08:00:00 |
| | -- Display records |
| | Display End : 09:00:00 |
| | -- Discard records |
| | Read End : 09:05:00 |
| | |
| | Example values: |
| | |
| | NONE - No cushion |
| | 0 - No cushion |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| LINEs count | Specifies the maximum number of data rows to |
| | be displayed. |
| | |
| | Default : 25000 |
| | Minimum : 1 |
| | Maximum : 1000000 |
| | |
| | Specifying the LINES value with the primary |
| | command syntax does not alter or change the |
| | default value stored in the user profile. |
| | |
| | The default value can be altered using the |
| | subcommand: OPTIONS LINES count |
| | |
| | The actual number of data rows displayed may |
| | be greater than the specified LINES value if |
| | a record or message expanded to multiple lines. |
| | |
+------------------+--------------------------------------------------+
| LIMit count | Specifies the maximum number of records to be |
| | read. |
| | |
| | Specifying the LIMIT value with the primary |
| | command syntax does not alter or change the |
| | default value stored in the user profile. |
| | |
| | The default value can be altered using the |
| | subcommand: OPTIONS LIMIT count |
| | |
| | Default : 1000000 |
| | |
+------------------+--------------------------------------------------+
| ELAPsed hh:mm:ss | Specifies the elapsed time limit for reading |
| | or searching the log streams for desired |
| | data. |
| | |
| | If the log stream being searched is very large, |
| | the search time required can be substantial. |
| | This is especially true if a large number |
| | of data LINES has been requested and the |
| | number of data records that would satisfy |
| | the search request are spread across the |
| | entire log stream. |
| | |
| | The log browse search will be interrupted |
| | when the elapsed time limit is reached. |
| | |
| | The search can be continued using the |
| | subcommands: NEXT or PREVIOUS |
| | |
| | Example values: |
| | |
| | NONE - No timeout |
| | 0 - No timeout |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| RECORDTime | Specifies whether the "start" or "end" date |
| RECTime | and time should be used for the records. |
| | |
| | Not all records have a start and an end |
| | time. Records that do not have both a start |
| | and an end time are considered "events". |
| | |
| | Records that are interval based typically |
| | do have a start and end time. |
| | |
| | Records that are event based typically do not. |
| | |
| | Valid values: |
| | |
| | END |
| | START |
| | EVENT |
| | |
+------------------+--------------------------------------------------+
| DISCard | Specifies whether records found to be in the |
| NODISCard | time period cushion should be discarded or |
| | kept. |
| | |
| | DISCARD - Discard the records found in |
| | the cushion. (default) |
| | |
| | NODISCARD - Keep the records found in the |
| | cushion. |
| | |
+------------------+--------------------------------------------------+
| FILTER | Display a "filter" screen to allow the |
| NOFILTER | entering of command syntax parameters to |
| | filter the data. |
| | |
| | When the "FILTER" keyword is entered as part |
| | of the primary command, the parameters entered |
| | will be used to populate the filter display. |
| | |
| | After entering desired data on the filter |
| | display, the following function keys can |
| | be used: |
| | |
| | ENTER - Validate the data entered. |
| | No processing occurs. |
| | |
| | F1 - Invoke HELP for the filter display. |
| | |
| | F3 - Validate the data entered and |
| | process the data to build the |
| | display. |
| | |
| | F12 - Do not validate data. No processing |
| | occurs. The existing data is |
| | redisplayed. |
| | |
| | FILTER - Display filter. |
| | |
| | NOFILTER - Do not display filter (default). |
| | |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| GROUP | Specifies a logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames to be |
| | displayed. |
| | |
| | Syntax: GROUP group |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used as the |
| | default. |
| | |
| | The current profile setting can be viewed using |
| | the following: QUERY CICSGROUP |
| | |
| | The list of CICSPLEX groups can be found on |
| | GROUPS command. |
+------------------+--------------------------------------------------+
| JOBName | Specifies the jobname that is to be displayed. |
| | |
| | The jobname can be specified as: |
| | * Specific jobname |
| | * Generic jobname |
| | * Logical group name containing a list of |
| | of CICS jobnames. |
| | Logical group type = CICSPLEX |
| | Syntax: ]group |
| | |
| | Syntax: JOBNAME jobname |
| | Generic or wildcard characters can be used. |
+------------------+--------------------------------------------------+
| TRAN | Specifies the transaction ID that is to be |
| | displayed. The "Tran" field will be examined |
| | for a match. |
| | |
| OTRAN | Specifies the originating transaction ID that |
| | is to be displayed. |
| | The "Tran" and "OTran" fields will be examined |
| | for a match. |
| | |
| | The transaction ID can be specified as: |
| | * Specific transaction ID |
| | * Generic transaction ID |
| | * Logical group name containing a list of |
| | of CICS transactions. |
| | Logical group type = CICSTRAN |
| | Syntax: ]group |
| | |
| | Syntax: TRAN tran |
| | Syntax: OTRAN tran |
| | Generic or wildcard characters can be used. |
| | |
| | If both "TRAN" and "OTRAN" are specified, the |
| | matching logic for the last keyword value |
| | pair specified will be used. |
+------------------+--------------------------------------------------+
| PROGRAM | Specifies the program name that is to be |
| | displayed. |
| | |
| | The program can be specified as: |
| | * Specific program |
| | * Generic program |
| | * Logical group name containing a list of |
| | of CICS programs. |
| | Logical group type = CICSPROG |
| | Syntax: ]group |
| | |
| | If the specified program name matches the |
| | transaction's initial program or a program |
| | used within the execution of the transaction, |
| | the transaction record will be included in |
| | the display. |
| | |
| | Syntax: PROGRAM program |
| | Generic or wildcard characters can be used. |
+------------------+--------------------------------------------------+
| TERMINAL | Specifies the terminal that is to be displayed. |
| | |
| | The "Term" and the "LUName" fields will be |
| | examined for a match. |
| | |
| | The terminal can be specified as: |
| | * Specific terminal |
| | * Generic terminal |
| | * Logical group name containing a list of |
| | of CICS terminals. |
| | Logical group type = CICSTERM |
| | Syntax: ]group |
| | |
| | Syntax: TERMINAL terminal |
| | Generic or wildcard characters can be used. |
+------------------+--------------------------------------------------+
| USERID | Specifies the userid that is to be displayed. |
| | |
| | The userid can be specified as: |
| | * Specific userid |
| | * Generic userid |
| | * Logical group name containing a list of |
| | of CICS userids. |
| | Logical group type = CICSUSER |
| | Syntax: ]group |
| | |
| | Syntax: USERID userid |
| | Generic or wildcard characters can be used. |
+------------------+--------------------------------------------------+
| UMBRELLA | Specifies the umbrella name that is to be |
| | displayed. |
| | |
| | Syntax: UMBRELLA umbrella |
| | Generic or wildcard characters can be used. |
+------------------+--------------------------------------------------+
| UMBTYPE | Specifies the umbrella type that is to be |
| | displayed. |
| | |
| | Syntax: UMBRELLA umbtype |
| | Generic or wildcard characters can be used. |
+------------------+--------------------------------------------------+
| DEFGROUP | Specifies the definition group that is to be |
| | displayed. |
| | |
| | Syntax: DEFGROUP defgroup |
| | Generic or wildcard characters can be used. |
+------------------+--------------------------------------------------+
| ABND | Specifies the abend code that is to be displayed.|
| | |
| | The abend code can be specified as: |
| | * Specific abend code |
| | * Generic abend code |
| | * Logical group name containing a list of |
| | of CICS abend codes. |
| | Logical group type = CICSABND |
| | Syntax: ]group |
| | |
| | Syntax: ABND abnd |
| | Generic or wildcard characters can be used. |
+------------------+--------------------------------------------------+
| EITRACE | Specifies the name of the EXEC Interface |
| | trace definition that requested EXEC CICS |
| | interface requests to be recorded. |
| | |
| | Syntax: EITRACE name |
| | Generic or wildcard characters can be used. |
+------------------+--------------------------------------------------+
| CLIENT | Specifies the client type that is to be |
| | displayed. |
| | |
| | Syntax: CLIENT client |
| | Generic or wildcard characters can be used. |
+------------------+--------------------------------------------------+
| WEBSERVICE | Specifies the webservice name that is to be |
| | displayed. |
| | |
| | The webservice can be specified as: |
| | * Specific webservice |
| | * Generic webservice |
| | * Logical group name containing a list of |
| | of CICS webservices. |
| | Logical group type = CICSWEBS |
| | Syntax: ]group |
| | |
| | Syntax: WEBSERVICE webservice |
| | Generic or wildcard characters can be used. |
| | The compare will be performed case insensitive. |
+------------------+--------------------------------------------------+
| URIPath | Specifies the URI path of the web request to be |
| | displayed. |
| | |
| | The URI path can be specified as: |
| | * Specific URI path |
| | * Generic URI path |
| | |
| | Syntax: URIPATH uripath |
| | Generic or wildcard characters can be used. |
| | The compare will be performed case insensitive. |
+------------------+--------------------------------------------------+
| FILEname | Specifies the filename that is to be displayed. |
| | |
| | The filename can be specified as: |
| | * Specific file name |
| | * Generic file name |
| | * Logical group name containing a list of |
| | of CICS file names. |
| | Logical group type = CICSFILE |
| | Syntax: ]group |
| | |
| | If the specified filename was used by the |
| | transaction, the record will be included in the |
| | display. |
| | |
| | Syntax: FILENAME filename |
| | Generic or wildcard characters can be used. |
+------------------+--------------------------------------------------+
| DB2 | Specifies the DB2 subsystem that is to be |
| | displayed. |
| | |
| | The DB2 subsystem can be specified as: |
| | * Specific DB2 subsystem |
| | * Generic DB2 subsystem |
| | * Logical group name containing a list of |
| | of DB2 subsystems. |
| | Logical group type = DB2SSID |
| | Syntax: ]group |
| | |
| | Syntax: DB2 ssid |
| | Generic or wildcard characters can be used. |
+------------------+--------------------------------------------------+
| QMGR | Specifies the MQ queue manager that is to be |
| | displayed. |
| | |
| | The MQ queue manager can be specified as: |
| | * Specific MQ queue manager |
| | * Generic MQ queue manager |
| | * Logical group name containing a list of |
| | of MQ queue managers. |
| | Logical group type = MQQMGR |
| | Syntax: ]group |
| | |
| | Syntax: QMGR qmgr |
| | Generic or wildcard characters can be used. |
+------------------+--------------------------------------------------+
| MQQueue | Specifies the MQ queue or object that is to be |
| | displayed. |
| | |
| | If the specified queue name or object matches |
| | an MQ object that was used by the transaction, |
| | the record will be included in the display. |
| | |
| | The MQ queue can be specified as: |
| | * Specific MQ queue |
| | * Generic MQ queue |
| | * Logical group name containing a list of |
| | of MQ queues |
| | Logical group type = MQQUEUE |
| | Syntax: ]group |
| | |
| | Syntax: MQQUEUE object.name |
| | Generic or wildcard characters can be used. |
| | The compare will be performed case insensitive. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| LIFETIME | Display those transactions that match the |
| | select criteria for transaction lifetime. |
| | Syntax: LIFETIME oper time |
+------------------+--------------------------------------------------+
| CPUTIME | Display those transactions that match the |
| | select criteria for transaction CPU time. |
| | Syntax: CPUTIME oper time |
+------------------+--------------------------------------------------+
| IOREQS | Display those transactions that match the |
| | select criteria for transaction I/O requests. |
| | Syntax: IOREQS oper count |
+------------------+--------------------------------------------------+
| XCT | Display those transactions that match the |
| | select criteria for transaction exceptions. |
| | Syntax: XCT oper count |
+------------------+--------------------------------------------------+
| oper | Selection operator |
| | Valid values are: |
| | |
| | EQ, = |
| | LT, [ |
| | LE, [= |
| | GT, ] |
| | GE, ]= |
| | NE, ¬=, [] |
| | NG, ¬] |
| | NL, ¬[ |
| | |
+------------------+--------------------------------------------------+
| time | Time value in seconds. |
| | The value can be specified in the following |
| | formats: |
| | |
| | 0.000000 |
| | HH:MM:SS |
| | |
+------------------+--------------------------------------------------+
| count | Count value |
+------------------+--------------------------------------------------+

Information Fields

The Information Section area is cursor selectable.


If the cursor is in the Information Section and the [ENTER] key
is pressed, the "FILTER" panel will be displayed.

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| LogStream | The name of the log stream from which data |
| | is being displayed. |
| | |
| | The keyword "ASIS" will follow the log stream |
| | name if the records are being read ASIS. |
| | ASIS specifies that no record decompression |
| | has been requested. |
+------------------+--------------------------------------------------+
| Retention | The log stream retention period. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Available | The time and date of the first and last records |
| | in the physical log stream. |
| | |
| | Commands that display the contents of log |
| | streams will only display those records that |
| | are relevant to the specific command. The log |
| | stream may contain other records. |
| | |
| | The available time and date information may not |
| | reflect the actual usable data records if the |
| | log stream contains data different than what |
| | corresponds to the active command. |
+------------------+--------------------------------------------------+
| Searched | The searched range of records processed. |
+------------------+--------------------------------------------------+
| Displayed | The current "display window" of records being |
| | displayed. |
| | |
| | The time and date of the first and last records |
| | displayed. |
| | |
| | This value can be modified to position to a new |
| | starting time and date. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Lines | Specifies the maximum number of data rows |
| | to be displayed. |
+------------------+--------------------------------------------------+
| Limit | Specifies the maximum number of records to be |
| | read in order to satisfy the specified "Lines" |
| | value. |
| | The value "NONE" indicates that no limit or |
| | "0" was specified. |
+------------------+--------------------------------------------------+
| Period | Specifies the time period for which records are |
| | to be displayed. |
| | The value "NONE" indicates that no time period |
| | was specified. |
+------------------+--------------------------------------------------+

Data Fields
Default Sort Order: Date,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Date | The end date of the transaction. |
+------------------+--------------------------------------------------+
| Time | The end time of the transaction. |
+------------------+--------------------------------------------------+
| Tran | The name of the transaction. If the transaction |
| | name is followed by a "+", then the record has |
| | been truncated. If the transaction name starts |
| | with a "+", then the record is a continuation |
| | record from a previously truncated record. |
| | The transaction is highlighted if the entry |
| | contains an abend, exception, or threshold |
| | information. |
+------------------+--------------------------------------------------+
| Task# | The number assigned to the transaction. |
+------------------+--------------------------------------------------+
| Program | The main program name. |
+------------------+--------------------------------------------------+
| Term | The CICS terminal name. |
+------------------+--------------------------------------------------+
| Userid | The userid that executed the transaction. |
+------------------+--------------------------------------------------+
| Lifetime | The life time of a transaction. |
+------------------+--------------------------------------------------+
| CPUtime | The cpu time used by a transaction. |
+------------------+--------------------------------------------------+
| IOReqs | The total I/O requests, from field DFHFILE 093. |
+------------------+--------------------------------------------------+
| Client | The client type at primary attach. |
| | |
| | Possible values are: |
| | |
| | NONE - None |
| | TERMINAL - Terminal |
| | TRANDATA - TranData |
| | START - Start |
| | STARTTERM - Start Terminal |
| | SCHEDULER - Scheduler |
| | XMRUNTRAN - XM Run Transaction |
| | BRIDGE - Bridge |
| | SOCKET - Socket |
| | WEB - Web |
| | RSSUR - RRS UR |
| | LU61 - LU61 Session |
| | APPC - APPC Session |
| | MRO - MRO Session |
| | IPECI - IP ECI |
| | IIRR - IIRR |
| | RZTRPORT - RZ Instore TRPort |
| | IS - IS Session |
| | EVENT - Event |
| | JVMSERVER - JVM Server |
| | ASRUNTRAN - AS Run Transaction |
| | |
+------------------+--------------------------------------------------+
| Pipeline | The pipeline used if any. |
+------------------+--------------------------------------------------+
| WebService | The web service used if any. |
+------------------+--------------------------------------------------+
| URIPath | Specifies the URI path of a web request. |
| | The first 64 characters are displayed. |
+------------------+--------------------------------------------------+
| LPARName | LPAR name |
+------------------+--------------------------------------------------+
| ONetwork | Origin network id |
+------------------+--------------------------------------------------+
| OApplid | Origin applid |
+------------------+--------------------------------------------------+
| OTran | Origin transaction id |
+------------------+--------------------------------------------------+
| OTask# | Origin task number |
+------------------+--------------------------------------------------+
| OFac | Origin facility name |
+------------------+--------------------------------------------------+
| Abnd | An abend code. |
+------------------+--------------------------------------------------+
| Xct | The number of exceptions. |
+------------------+--------------------------------------------------+
| EXEC% | The percentage of time spent executing. |
+------------------+--------------------------------------------------+
| WAIT% | The percentage of time spent waiting. |
+------------------+--------------------------------------------------+
| LongRun | Specifies if the transaction is defined as a |
| | long running transaction. |
| | |
| | Long running transaction are defined using |
| | the CICS Transaction Options command: CTRANOPT |
| | |
| | Exceptions are not evaluated for the following |
| | metrics when the transaction has been defined |
| | as long running: |
| | |
| | LIFETIME |
| | |
+------------------+--------------------------------------------------+
| Debug | Indicates that an application debugger was |
| | active during the execution of the transaction. |
| | |
| | Possible values are: |
| | |
| | blank - Debugger was not active |
| | DEBUG - Debugger was active |
| | |
+------------------+--------------------------------------------------+
| Resptime | The response time of a transaction. |
| | Response time will only be present for those |
| | transactions that perform terminal I/O. |
+------------------+--------------------------------------------------+
| DISPTIME | Dispatch time |
+------------------+--------------------------------------------------+
| SUSPTIME | Suspend time |
+------------------+--------------------------------------------------+
| EXWTIME | CICS exception wait time |
+------------------+--------------------------------------------------+
| DSPDELAY | Dispatch delay time - 1st |
+------------------+--------------------------------------------------+
| FCPTIME | File I/O wait time |
+------------------+--------------------------------------------------+
| MROTIME | Inter-region wait time |
+------------------+--------------------------------------------------+
| MXTDELAY | MXT delay 1st dispatch |
+------------------+--------------------------------------------------+
| RMITIME | Resource Manager Interface |
+------------------+--------------------------------------------------+
| RMISUSP | Resource Manager Suspend |
+------------------+--------------------------------------------------+
| Termtime | The terminal I/O time. |
+------------------+--------------------------------------------------+
| TCLDELAY | Tran class delay 1st disp |
+------------------+--------------------------------------------------+
| RMITOTAL | RMI time - Total |
+------------------+--------------------------------------------------+
| RMICPSM | RMI time - CICSPlex SM |
+------------------+--------------------------------------------------+
| RMIDBCTL | RMI time - DBCTL |
+------------------+--------------------------------------------------+
| RMIDB2 | RMI time - DB2 |
+------------------+--------------------------------------------------+
| RMIEXDLI | RMI time - EXEC DLI |
+------------------+--------------------------------------------------+
| RMIMQM | RMI time - MQ |
+------------------+--------------------------------------------------+
| RMIOTHER | RMI time - Other |
+------------------+--------------------------------------------------+
| RMITCPIP | RMI time - TCP/IP sockets |
+------------------+--------------------------------------------------+
| WTRTIME | Waiting to run time |
+------------------+--------------------------------------------------+
| GSVITIME | Global user exit monitor time |
+------------------+--------------------------------------------------+
| GSVICPU | Global user exit cpu time |
+------------------+--------------------------------------------------+
| CALen | The maximum COMMAREA length used by a program. |
+------------------+--------------------------------------------------+
| CDSA | CICS DSA storage high water mark |
+------------------+--------------------------------------------------+
| UDSA | User DSA storage high water mark |
+------------------+--------------------------------------------------+
| SDSA | Shared DSA bytes getmained |
+------------------+--------------------------------------------------+
| ECDSA | Extended CICS DSA storage high water mark |
+------------------+--------------------------------------------------+
| EUDSA | Extended User DSA storage high water mark |
+------------------+--------------------------------------------------+
| ESDSA | Extended Shared DSA bytes getmained |
+------------------+--------------------------------------------------+
| GCDSA | Grande CICS DSA storage high water mark |
+------------------+--------------------------------------------------+
| GUDSA | Grande User DSA storage high water mark |
+------------------+--------------------------------------------------+
| LUName | The VTAM LU name. |
+------------------+--------------------------------------------------+
| Type | The transaction type. Values can be: |
| | |
| | TO - Attached from terminal input |
| | S - Attached by automatic transaction |
| | initiation (ATI) without data |
| | SD - Attached by automatic transaction |
| | initiation (ATI) with data |
| | QD - Attached by transient data trigger |
| | level |
| | U - Attached by user request |
| | TP - Attached from terminal TCTTE tran ID |
| | SZ - Attached by Front End Programming |
| | Interface (FEPI) |
| | |
+------------------+--------------------------------------------------+
| RType | The transaction record output type. |
| | Values can be: |
| | |
| | C - Terminal converse |
| | D - Use EMP DELIVER request |
| | F - Long-running transaction |
| | S - Syncpoint |
| | T - Task termination |
| | |
+------------------+--------------------------------------------------+
| DB2 | The DB2 subsystem used by the transaction. |
| | |
| | The following configuration options were |
| | required while the transaction was executing |
| | to obtain this information. |
| | |
| | Option Value |
| | -------------------------- ---------------- |
| | TRANSACTION-DATA-DB2 SUMMARY|DETAIL |
| | TRANSACTION-RECORD-DB2 YES |
| | |
+------------------+--------------------------------------------------+
| QMgr | The MQ queue manager used by the transaction. |
| | |
| | The following configuration options were |
| | required while the transaction was executing |
| | to obtain this information. |
| | |
| | Option Value |
| | -------------------------- ---------------- |
| | TRANSACTION-DATA-WEBMQ YES |
| | TRANSACTION-RECORD-WEBMQ YES |
| | |
+------------------+--------------------------------------------------+
| Collect | The level of data that was collected for the |
| | transaction. Collection levels are specified |
| | on CICS Transaction Option definitions. |
| | |
| | Possible values are: |
| | |
| | DETAIL |
| | SUMMARY |
| | |
+------------------+--------------------------------------------------+
| Umbrella | The umbrella transaction name. |
+------------------+--------------------------------------------------+
| UmbType | The umbrella type. |
+------------------+--------------------------------------------------+
| EICnt | The number of EXEC Interface requests. |
+------------------+--------------------------------------------------+
| EITrace | The name of the EXEC Interface trace definition |
| | that requested EXEC CICS interface requests |
| | to be recorded. |
+------------------+--------------------------------------------------+
| DefGroup | The name of the definition group from where |
| | the entry was installed. |
+------------------+--------------------------------------------------+
| CICS | The CICS version number. |
+------------------+--------------------------------------------------+
| NetName | The unit of work network name. |
+------------------+--------------------------------------------------+
| UOWID | The unit of work ID. |
+------------------+--------------------------------------------------+
| Seq | The unit of work sequence number. |
+------------------+--------------------------------------------------+
| TranGroupID | The transaction group ID. |
+------------------+--------------------------------------------------+
| GUIDType | The Cross Enterprise APM correlation type. |
| | |
| | Possible values are: |
| | |
| | blank - None |
| | CHANCONT - Channel Container |
| | COMMDYN - CommArea Dynamic |
| | COMMSTAT - CommArea Static |
| | COMMRETR - CommArea or Retrieve |
| | CTGCHAN - CTG Channel |
| | HTTPWEB - HTTP Web Service |
| | MQTRIG - MQ Trigger Msg |
| | SOAPWEB - SOAP Web Service |
| | USER - User Correlation |
| | W3CTRACE - W3C Tracing |
| | |
+------------------+--------------------------------------------------+
| GUIDData | The Cross Enterprise APM correlation data. |
+------------------+--------------------------------------------------+
| Length | The record length. |
+------------------+--------------------------------------------------+
| BlockID | Block ID assigned to the log record. |
+------------------+--------------------------------------------------+
| SubRec | Sub-record number within a block. |
+------------------+--------------------------------------------------+
| CmpLen | Length of the compressed record |
+------------------+--------------------------------------------------+
| Cmp% | Compression percentage |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DRO | Delete records older than the entry selected. |
| | Invokes the LGDRO command. |
+------------------+--------------------------------------------------+
| PRint | Displays the detail screen for a record, prints |
| | the detail report to a sysout data set and then |
| | returns to the display screen. If a SYSOUT |
| | print data set was not open this line command |
| | will cause it to be opened. All subsequent |
| | PRINT line commands will print to the same |
| | SYSOUT data set until a PRINT CLOSE command is |
| | issued or until the session terminates. |
+------------------+--------------------------------------------------+
| UOW | Select transactions with matching UOWID. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Dump | Dump the contents of a record. |
+------------------+--------------------------------------------------+
| SD | Select and dump. |
| | |
| | A detailed report followed by a dump of the |
| | contents of the record is displayed. |
+------------------+--------------------------------------------------+
| Idb2 | Invoke the IDB2 (SYSVIEW for DB2) command to |
| | display thread history. |
+------------------+--------------------------------------------------+
| Select | Display the detail screen for a record. |
| | Detail report information |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| BACkward | Read the previous block of records in the log |
| PREVious | starting with the first record displayed on the |
| | screen. The number of records read is |
| | controlled by the LINES option, which can be set |
| | using the OPTIONS subcommand. |
+------------------+--------------------------------------------------+
| EOF | Go to the end of the log. |
| EOL | |
+------------------+--------------------------------------------------+
| FORward | Read the next block of records in the log |
| NEXT | starting with the last record displayed on the |
| | screen. The number of records read is |
| | controlled by the LINES option, which can be set |
| | using the OPTIONS subcommand. |
+------------------+--------------------------------------------------+
| OPTions | Set and display miscellaneous command options. |
+------------------+--------------------------------------------------+
| POSition | Position to a time and date. |
| | |
| | Syntax : POSITION time [date] |
| | |
| | time - The time value must be specified |
| | using the time format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | If "*" is specified, the current |
| | time will be used. |
| | |
| | The time value can also be |
| | specified using one of the |
| | following values: |
| | 12AM | 1AM | 2AM | ... | 11AM |
| | 12PM | 1PM | 2PM | ... | 11PM |
| | NOON | MIDNIGHT |
| | |
| | Query current time format |
| | |
| | date - The date value must be specified |
| | using the date format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | If "*" is specified, the current |
| | date will be used. |
| | |
| | Query current date format |
| | |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| TOF | Go to the top of the log. |
| TOL | |
+------------------+--------------------------------------------------+
| FILTER | Display a "filter" screen to allow the entering |
| | command syntax parameters to filter the data. |
+------------------+--------------------------------------------------+

OPTIONS Subcommand

The OPTIONS subcommand sets and displays miscellaneous command


options.

Entering the OPTIONS subcommand with no parameters displays the


current option values.

Multiple option values can be entered as a single command.

OPTIONS Subcommand format

+------------------+--------------------------------------------------+
| OPTIONS | [options] |
+------------------+--------------------------------------------------+

OPTIONS Subcommand Parameter Values

+------------------+--------------------------------------------------+
| Value | Explanation |
+------------------+--------------------------------------------------+
| LINEs | Specifies the maximum number of data rows to |
| | be displayed. |
| | |
| | Syntax : OPTIONS LINES count |
| | |
| | Default : 25000 |
| | Minimum : 1 |
| | Maximum : 1000000 |
| | |
+------------------+--------------------------------------------------+
| LIMit | Specifies the maximum number of records to be |
| | read. |
| | |
| | Syntax : OPTIONS LIMIT count |
| | |
| | Default : 1000000 |
| | |
+------------------+--------------------------------------------------+
| PERiod | Specifies the time period for which records are |
| | to be displayed. |
| | |
| | Syntax : OPTIONS PERIOD hh:mm:ss |
| | |
| | Default : 0 (unlimited) |
| | |
| | Example values: |
| | |
| | NONE - No period (unlimited) |
| | 0 - No period (unlimited) |
| | 0.500000 - 0.5 seconds |
| | 60 - 60 seconds |
| | 120Sec - 120 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | 1Days - 1 day |
| | 1MONths - 1 month |
| | 1Years - 1 year |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| CUSHion | Specifies the time period cushion for which |
| | records are to be read for display. |
| | |
| | Data records stored in an MVS log stream are |
| | sequenced or sorted based on the actual time |
| | the record was written to the stream. |
| | |
| | This does not guarantee that the records |
| | are sorted in a time sequence based on the |
| | date and time information that is potentially |
| | contained within each record. |
| | |
| | For this reason, when a user wants to display |
| | a specific time period of data, additional |
| | records must be read on the front and back |
| | end of the read process to ensure that the |
| | records that might be out of sequence are |
| | included. |
| | |
| | The time period cushion specifies the extra |
| | records to be read. |
| | |
| | Syntax : OPTIONS CUSHION hh:mm:ss |
| | |
| | Example Cushion: |
| | |
| | Start time: 8AM |
| | Period : 1 Hour |
| | Cushion : 5 minutes |
| | |
| | Read Begin : 07:55:00 |
| | -- Discard records |
| | Display Begin : 08:00:00 |
| | -- Display records |
| | Display End : 09:00:00 |
| | -- Discard records |
| | Read End : 09:05:00 |
| | |
| | Example values: |
| | |
| | NONE - No cushion |
| | 0 - No cushion |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| ELAPsed | Specifies the elapsed time limit for reading |
| ELAPsedlimit | or searching the log streams for desired data. |
| | |
| | If the log stream being searched is very large, |
| | the search time required can be substantial. |
| | This is especially true if a large number of |
| | data LINES has been requested and the number |
| | of data records that would satisfy the search |
| | request are spread across the entire log stream. |
| | |
| | The log browse search will be interrupted |
| | when the elapsed time limit is reached. |
| | |
| | The search can be continued using the |
| | subcommands: NEXT or PREVIOUS |
| | |
| | Syntax : OPTIONS ELAPSED hh:mm:ss |
| | |
| | Default : 00:00:30 |
| | |
| | Example values: |
| | |
| | NONE - No limit |
| | 0 - No limit |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| RECORDTime | Specifies whether the "start" or "end" date |
| RECTime | and time should be used for the records. |
| | |
| | Not all records have a start and an end time. |
| | |
| | Records that are interval based typically do |
| | have a start and end time. |
| | |
| | Records that are event based typically do not. |
| | |
| | Syntax : OPTIONS RECTIME END|START |
| | |
| | Valid values are: |
| | |
| | END (default) |
| | START |
| | |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC |
| | variable. The variable created or updated is |
| | named SYSV_OPTIONS_cmdname. EXTRACT is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. EXTRACT can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+------------------+--------------------------------------------------+
| FILTER | Specifies that the "filter" display screen |
| | is to be displayed to allow the entering of |
| | command syntax parameters. |
| | |
| | The "filter" display screen will be displayed |
| | each time the command is invoked unless the |
| | NOFILTER parameter is entered as part of the |
| | primary command syntax. |
| | |
| | Syntax : OPTIONS FILTER |
| | |
+------------------+--------------------------------------------------+
| NOFILTER | Specifies that the "filter" display screen |
| | is not to be displayed. |
| | |
| | The NOFILTER option can be overridden by |
| | entering the FILTER parameter as part of the |
| | primary command syntax. |
| | |
| | The subcommand FILTER can also be used to |
| | display the "filter" display screen. |
| | |
| | Syntax : OPTIONS NOFILTER |
| | |
+------------------+--------------------------------------------------+
| RESET | Request to option values to the defaults. |
| | |
| | Syntax : OPTIONS RESET |
| | |
+------------------+--------------------------------------------------+

Notes

Example command usage:

* Display transactions that used DB2


CTRANLOG DB2 =

* Display transactions that used MQ


CTRANLOG QMGR =

* Display transactions that made file requests


CTRANLOG FILENAME =

* Display transactions with a life time greater than 1 second


CTRANLOG LIFETIME GT 1

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Related Information

SYSVIEW Usage of MVS Log Streams

Security Requirements

The display of log record information can be controlled


by security definitions. The number of security calls can
be large. Two security calls are made for each log record
to verify the authorization to display the jobname and
transaction ID. The security checks are also performed
when the log record is selected for detailed display.

To enable security validation for CICS log displays, set


the following options in the parmlib member:

sysview.CNM4BPRM(OPTIONS)

SECURE-CICSLOG-BY-JOBNAME Yes
SECURE-CICSLOG-BY-TRAN Yes

If the security option for "Display Unauthorized Jobs"


is set to YES, then the security check for the jobname
is bypassed at the summary screen level. This means that
summary information can be displayed for all records,
but detailed information is controlled by security
definitions. This can reduce the number of security
checks being made.

For security requirements, follow the link:

CTRANLOG command security


CTRANOPT

CTRANOPT Command

The CTRANOPT command is used to display and maintain a single set


or transaction option definitions that are used for all CICS
regions being monitored by SYSVIEW on the current system.

Definitions can be added or maintained here (warm start) or


in parmlib member CTRANOPT (cold start).

The SYSVIEW for CICS data collector monitors every CICS


transaction executing in a CICS region. On some occasions,
you may want to alter the monitoring characteristics for
transactions. Transaction option definitions allow the
monitoring characteristics to be specified.

The following options can be set:

* Specify transactions that are required to be active

* Exception processing

* Transaction collection level - DETAIL or SUMMARY

* Logging of the detailed transaction record to the


transaction log stream

* Logging of the detailed transaction record to SMF

* Sending the detailed transaction record to the


MVS dynamic exit: GSVX.CICSTRAN

* Sending monitored transaction information to


Cross-Enterprise APM

* Suppress CICS SMF 110 subtype 1 records

* Specify transaction elapsed time monitoring method

* Define long running transactions

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTRANOPT | [ function [ parameters ] ] |
| | |
| +--------------------------------------------------+
| | |
| | Function Parameters |
| | ----------- ------------------------------------ |
| | ADDLINE |
| | NOADDLINE |
| | |
| | ADD |
| | |
| | DELETE tran jobname |
| | |
| | EMPTY |
| | |
| | EXPORT dataset.name(member) |
| | |
| | LOAD member |
| | |
| | RELOAD [ blank | * | WARM ] |
| | [ member ] |
| | [ DATALIB ] |
| | [ COLD ] |
| | |
| | RESET tran jobname |
| | |
| | SAVE |
| | |
+------------------+--------------------------------------------------+

If SELECT is used with this command, the dummy input line for adding
new definitions always displays. The dummy add line is being excluded
from the select process.

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| ADDLINE | Specify whether the "?Add" data line should |
| NOADDLINE | be displayed. |
| | |
| | The "?Add" line can be used to create a new |
| | definition. It may be desirable to exclude the |
| | "?Add" data line when the data is being |
| | displayed using a non-3270 interface. |
+------------------+--------------------------------------------------+
| ADD | Add new definition. |
| | A full screen input panel will be displayed. |
| | |
| | Syntax: CTRANOPT ADD |
| | |
+------------------+--------------------------------------------------+
| DELETE | Delete an existing definition. |
| | |
| | Parameters: |
| | tran - transaction ID |
| | jobname - CICS jobname |
| | |
| | Syntax: CTRANOPT DELETE tran jobname |
| | |
+------------------+--------------------------------------------------+
| EMPTY | Delete all existing definitions. |
+------------------+--------------------------------------------------+
| LOAD | Load definitions. |
| | |
| | Existing definitions will NOT be deleted. |
| | |
| | member - Load definitions from the |
| | specified parmlib member. |
| | |
+------------------+--------------------------------------------------+
| RESET | Reset the attributes of an existing definition |
| | back to the defaults. The default attributes |
| | are shown on the "?Add" line. |
| | |
| | Parameters: |
| | tran - transaction ID |
| | jobname - CICS jobname |
| | |
| | Syntax: CTRANOPT RESET tran jobname |
| | |
+------------------+--------------------------------------------------+
| RELOAD | Reload definitions. |
| | |
| | Existing definitions will be deleted. |
| | |
| | * - Reload definitions from the |
| | blank persistent data store. If the |
| | WARM object is not found in the |
| | persistent data store, reload |
| | the definitions from parmlib. |
| | |
| | The parmlib member to be used |
| | is: CTRANOPT |
| | |
| | DATALIB - Reload definitions from the |
| | persistent data store. |
| | |
| | COLD - Reload definitions from parmlib. |
| | |
| | member - Reload definitions from the |
| | specified parmlib member. |
| | |
+------------------+--------------------------------------------------+
| EXPORT | Exports definitions to a specific member of |
| | a data set. |
| | |
| | Syntax: EXPORT member |
| | dsname(member) |
| | |
| | Parameter Description |
| | ---------- --------------------------------- |
| | member The name of the member to be |
| | saved. |
| | |
| | dsname The data set name where the |
| | specified member is saved. |
| | |
| | The data set name can be |
| | specified as a fully qualified |
| | data set name or using one of the |
| | following special keywords: |
| | |
| | Keyword Description |
| | ---------- ------------------------------- |
| | USER Uses the optional data set name |
| | defined in the user profile |
| | for the library type PARMLIB. |
| | |
| | Example: USER(member) |
| | |
| | SITE Uses the optional site PARMLIB |
| | data set that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITE(member) |
| | |
| | SYSTEM Uses the system PARMLIB data set |
| | that is defined in the system |
| | configuration options parmlib |
| | member: GSVXGSVX |
| | |
| | Example: SYSTEM(member) |
| | |
| | SITESYSTEM Uses the first defined data |
| | SITE.SYSTEM set from the following list |
| | * of eligible data set names: |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITESYSTEM(member) |
| | SITE.SYSTEM(member) |
| | *(member) |
| | |
| | USERSITE Uses the first defined data |
| | USER.SITE set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSITE(member) |
| | USER.SITE(member) |
| | |
| | USERSYSTEM Uses the first defined data |
| | USER.SYSTEM set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSYSTEM(member) |
| | USER.SYSTEM(member) |
| | |
| | The above keywords can be cursor selected |
| | invoking a hyperlink to the PARMLIB command |
| | showing the available data sets for the |
| | keyword. |
| | |
+------------------+--------------------------------------------------+
| SAVE | Save the definitions to the persistent data |
| | store. |
| | |
| | The definitions will be stored using a |
| | DataID = "CTRANOPT". |
| | |
| | Persistent store DATALIB list |
| | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | Specifies the definitions are system wide. |
| | The definitions are used by all CICS regions |
| | on the current system. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Tran | The CICS transaction ID. |
| | |
| | The transaction ID can be specified as: |
| | |
| | * Specific transaction ID |
| | * Generic transaction ID |
| | * Logical group name containing a list of |
| | CICS transactions. |
| | Logical group type = CICSTRAN |
| | Syntax: ]group |
| | |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname to which the definition is |
| | to be applied. |
| | |
| | The jobname can be specified as: |
| | |
| | * Specific CICS jobname |
| | * Generic CICS jobname |
| | * Logical group name containing a list of |
| | CICS jobnames. |
| | Logical group type = CICSPLEX |
| | Syntax: ]group |
| | |
+------------------+--------------------------------------------------+
| UmbType | Specifies the umbrella type to be associated |
| | with the transaction. |
| | |
| | Example usage: |
| | This could be used to associate a name |
| | with a group of "like" transactions. |
| | You may want to set the umbrella type to |
| | "PAYROLL" for all payroll transactions. |
+------------------+--------------------------------------------------+
| Collect | Specifies the level of data collection that is |
| | to be performed for a transaction. |
| | |
| | Valid values are: |
| | |
| | DETAIL - Collect detailed resource usage: |
| | |
| | * CICS SMF 110 subtype 1 content |
| | * DB2 requests |
| | * DLI requests |
| | * EXEC CICS requests |
| | * File requests |
| | * Program usage |
| | * Resource Manager requests |
| | * Transient data requests by |
| | queue |
| | * Temporary storage requests by |
| | queue |
| | * MQ requests by object |
| | |
| | SUMMARY - Collect summary resource usage: |
| | |
| | * CICS SMF 110 subtype 1 content |
| | * Detailed resource usage is not |
| | included |
| | |
+------------------+--------------------------------------------------+
| Thresh | Specifies if exception processing is to be |
| | performed for the transaction. This includes |
| | the following types of data collection: |
| | |
| | * Transaction detail |
| | * Transaction summary |
| | * System data |
| | |
| | Valid values are: |
| | |
| | THRESH - Exception processing is performed. |
| | |
| | * Dynamic transaction evaluation |
| | during transaction execution |
| | * Evaluation at task termination |
| | * Task is eligible for |
| | cancellation based on |
| | exception definitions |
| | |
| | NOTHRESH - No exception processing is |
| | performed. |
| | |
| | * Task is not eligible for |
| | cancellation based on |
| | exception definitions |
| | |
+------------------+--------------------------------------------------+
| CanEligible | Specifies if the transaction is eligible for |
| | cancellation based on exception definitions. |
| | |
| | Valid values are: |
| | |
| | CANCEL - The transaction is eligible for |
| | cancellation based on exception |
| | definitions. |
| | |
| | NOCANCEL - The transaction is not eligible |
| | for cancellation based on |
| | exception definitions. |
| | |
+------------------+--------------------------------------------------+
| TranLog | Specifies if a transaction record is to be |
| | sent to a CICS logger task running in the |
| | main services address space so that the record |
| | can be written to the defined log stream. |
| | |
| | Online statistics are maintained even if the |
| | data is not logged. |
| | |
| | Valid values are: |
| | |
| | TRANLOG - Write an SMF transaction record |
| | to the transaction log stream. |
| | |
| | NOTRANLOG - A transaction record is not |
| | logged unless overridden by one |
| | of the following SVWCOPTS |
| | configuration options: |
| | |
| | TRANSACTION-LOG-IF-ABEND |
| | TRANSACTION-LOG-IF-CICSEXC |
| | TRANSACTION-LOG-IF-THRESHOLD |
| | |
+------------------+--------------------------------------------------+
| SMF | Specifies if a transaction record is to be |
| | sent to a CICS logger task running in the |
| | main services address space so that the record |
| | can be written to SMF. |
| | |
| | Valid values are: |
| | |
| | SMF - Write an SMF transaction record |
| | to SMF. |
| | |
| | NOSMF - A transaction record is not |
| | logged unless overridden by one |
| | of the following SVWCOPTS |
| | configuration options: |
| | |
| | TRANSACTION-LOG-IF-ABEND |
| | TRANSACTION-LOG-IF-CICSEXC |
| | TRANSACTION-LOG-IF-THRESHOLD |
| | |
+------------------+--------------------------------------------------+
| DynExit | Specifies if a transaction record is to be |
| | sent to a CICS logger task running in the |
| | main services address space so that the record |
| | can be passed to the dynamic exit GSVX.CICSTRAN. |
| | |
| | Valid values are: |
| | |
| | DYNEXIT - Send record to dynamic exit |
| | |
| | NODYNEXIT - A transaction record is not |
| | sent unless overridden by one |
| | of the following SVWCOPTS |
| | configuration options: |
| | |
| | TRANSACTION-LOG-IF-ABEND |
| | TRANSACTION-LOG-IF-CICSEXC |
| | TRANSACTION-LOG-IF-THRESHOLD |
| | |
+------------------+--------------------------------------------------+
| CEAPM | Specifies if transaction information is to be |
| | sent to a CICS logger task running in the Main |
| | Services address space so that the information |
| | can be sent to Cross-Enterprise APM for |
| | transaction tracing. The information is |
| | collected and sent only when the |
| | Cross-Enterprise APM product has |
| | requested the transaction to be traced. |
| | |
| | Valid values are: |
| | |
| | CEAPM - Send information |
| | |
| | NOCEAPM - Information is not sent unless |
| | overridden by one of the |
| | following SVWCOPTS |
| | configuration options: |
| | |
| | TRANSACTION-LOG-IF-ABEND |
| | TRANSACTION-LOG-IF-CICSEXC |
| | TRANSACTION-LOG-IF-THRESHOLD |
| | |
+------------------+--------------------------------------------------+
| Suppress | Specifies whether CICS SMF 110 performance |
| | records are to be suppressed for the transaction.|
| | |
| | Valid values are: |
| | |
| | SUPPRESS - Suppress records |
| | |
| | NOSUPPRESS - Do not suppress records |
| | |
+------------------+--------------------------------------------------+
| Required | Specifies whether the transaction is required |
| | to be active. |
| | |
| | Valid values are: |
| | |
| | REQUIRED - The transaction is required to |
| | be active. At least one |
| | transaction with the specified |
| | transaction ID must be active. |
| | A specific transaction ID is |
| | required. |
| | |
| | The transaction presence is |
| | verified on an interval basis |
| | defined by the scheduled event |
| | function TRAN-REQUIRED |
| | |
| | NOREQUIRED - The transaction is not required |
| | to be active. |
| | |
+------------------+--------------------------------------------------+
| LongRun | Specifies whether the transaction is a long |
| | running transaction. |
| | |
| | Valid values are: |
| | |
| | LONGRUN - The transaction is to be defined |
| | as a long running transaction. |
| | Some long running transactions |
| | might be thought of as "server" |
| | transactions. |
| | |
| | Long running transactions take |
| | on the following attributes or |
| | characteristics: |
| | |
| | * At transaction termination, |
| | degradation analysis |
| | statistics are normally |
| | summarized for the following: |
| | |
| | * Transaction ID specific |
| | * Transaction groups |
| | * All transactions for the |
| | CICS region |
| | Example: The '*' entry on |
| | the CTRANDEG command. |
| | |
| | * Long running transactions tend |
| | to have a transaction lifetime |
| | higher than the average |
| | transaction. Therefore, |
| | degradation analysis |
| | information is not added to |
| | the "all transactions" |
| | summary. Adding information to |
| | the "all transactions" summary |
| | will adversely skew the timing |
| | values. Transaction usage |
| | counts are maintained. |
| | |
| | * The transaction lifetime |
| | or elapsed time since attach |
| | is not evaluated during |
| | threshold processing. |
| | Metrics: |
| | |
| | CICS_TRAN_CICS_LifeTime |
| | CICS_TSUM_LifeTime |
| | |
| | |
| | NOLONGRUN - The transaction is not defined |
| | as a long running transaction. |
| | |
+------------------+--------------------------------------------------+
| Elapsed | Specifies when elapsed time monitoring is to |
| | begin. |
| | |
| | Valid values are: |
| | |
| | FIRST - Elapsed time since last used is |
| | calculated after the first usage |
| | of the transaction. |
| | |
| | INIT - Elapsed time since last used is |
| | calculated from the start of |
| | data collection until the |
| | transaction is first used. |
| | Once the transaction has been |
| | used, the elapsed time is |
| | calculated as time since last |
| | usage. |
| | |
+------------------+--------------------------------------------------+
| MatchJob | Indicates whether the definition matches the |
| | current target jobname. |
| | |
| | Possible values are: |
| | |
| | YES - The definition applies to or matches |
| | the current target jobname. |
| | |
| | blanks - The definition does not apply to or |
| | match the current target jobname. |
| | |
| | If the current target jobname |
| | displayed in the information section |
| | is not a monitored CICS jobname, |
| | "blanks" will also be displayed. |
| | |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Add | Add a new definition. |
| | This line command can only be entered on the |
| | "?Add" input line. |
+------------------+--------------------------------------------------+
| Copy | Copy the definition attributes and create a |
| | new definition. |
+------------------+--------------------------------------------------+
| DELete | Delete the selected definition. |
+------------------+--------------------------------------------------+
| Edit | Edit the selected definition. |
+------------------+--------------------------------------------------+
| RESet | Reset the definition attributes back to the |
| | defaults. The default attributes are shown on |
| | the "?Add" line. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Group | Display CICS logical group definitions. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| ADD | Add new definition. |
| | |
| | Syntax: ADD |
| | |
+------------------+--------------------------------------------------+
| DELETE | Delete an existing definition. |
| | |
| | Syntax: DELETE tran jobname |
| | |
| | Parameters: |
| | tran - transaction ID |
| | jobname - CICS jobname |
| | |
| | Syntax: DELETE tran jobname |
| | |
+------------------+--------------------------------------------------+
| EMPTY | Delete all existing definitions. |
| | |
| | Syntax: EMPTY |
| | |
+------------------+--------------------------------------------------+
| LOAD | Load definitions. |
| | |
| | Existing definitions will NOT be deleted. |
| | |
| | Syntax: LOAD member |
| | |
| | member - Load definitions from the |
| | specified parmlib member. |
| | |
+------------------+--------------------------------------------------+
| RESET | Reset the attributes of an existing definition |
| | back to the defaults. The default attributes |
| | are shown on the "?Add" line. |
| | |
| | Parameters: |
| | tran - transaction ID |
| | jobname - CICS jobname |
| | |
| | Syntax: RESET tran jobname |
| | |
+------------------+--------------------------------------------------+
| RELOAD | Reload definitions. |
| | |
| | Existing definitions will be deleted. |
| | |
| | Syntax: RELOAD member |
| | |
| | * - Reload definitions from the |
| | blank persistent data store. If the |
| | WARM object is not found in the |
| | persistent data store, reload |
| | the definitions from parmlib. |
| | |
| | The parmlib member to be used |
| | is: CTRANOPT |
| | |
| | DATALIB - Reload definitions from the |
| | persistent data store. |
| | |
| | COLD - Reload definitions from parmlib. |
| | |
| | member - Reload definitions from the |
| | specified parmlib member. |
| | |
+------------------+--------------------------------------------------+
| EXPORT | Exports definitions to a specific member of |
| | a data set. |
| | |
| | Syntax: EXPORT member |
| | dsname(member) |
| | |
| | Parameter Description |
| | ---------- --------------------------------- |
| | member The name of the member to be |
| | saved. |
| | |
| | dsname The data set name where the |
| | specified member is saved. |
| | |
| | The data set name can be |
| | specified as a fully qualified |
| | data set name or using one of the |
| | following special keywords: |
| | |
| | Keyword Description |
| | ---------- ------------------------------- |
| | USER Uses the optional data set name |
| | defined in the user profile |
| | for the library type PARMLIB. |
| | |
| | Example: USER(member) |
| | |
| | SITE Uses the optional site PARMLIB |
| | data set that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITE(member) |
| | |
| | SYSTEM Uses the system PARMLIB data set |
| | that is defined in the system |
| | configuration options parmlib |
| | member: GSVXGSVX |
| | |
| | Example: SYSTEM(member) |
| | |
| | SITESYSTEM Uses the first defined data |
| | SITE.SYSTEM set from the following list |
| | * of eligible data set names: |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: SITESYSTEM(member) |
| | SITE.SYSTEM(member) |
| | *(member) |
| | |
| | USERSITE Uses the first defined data |
| | USER.SITE set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * Optional site PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSITE(member) |
| | USER.SITE(member) |
| | |
| | USERSYSTEM Uses the first defined data |
| | USER.SYSTEM set from the following list |
| | of eligible data set names: |
| | |
| | * Optional data set defined |
| | in the user profile for the |
| | library type PARMLIB. |
| | |
| | * The system PARMLIB data set |
| | that is defined in the |
| | system configuration options |
| | parmlib member: GSVXGSVX |
| | |
| | Example: USERSYSTEM(member) |
| | USER.SYSTEM(member) |
| | |
| | The above keywords can be cursor selected |
| | invoking a hyperlink to the PARMLIB command |
| | showing the available data sets for the |
| | keyword. |
| | |
+------------------+--------------------------------------------------+
| SAVE | Save the definitions to the persistent data |
| | store. |
| | |
| | The definitions will be stored using a |
| | DataID = "CTRANOPT". |
| | |
| | Persistent store DATALIB list |
| | |
| | Syntax: SAVE |
| | |
+------------------+--------------------------------------------------+

Related Information

Long running transactions

Security Requirements

For security requirements, use the link: CTRANOPT command security


CTRANS

CTRANS Command

The CTRANS command displays transaction definitions along with


summary usage information. If CICS transaction groups have been
defined, an entry for the transaction group will also be displayed.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTRANS | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
| | [ SYSInterval | INTerval | TOTal ] |
| | |
| | [ GRPSONLY ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
| SYSINTERVAL | Display transaction metrics based on the data |
| | collected during the current transaction summary |
| | interval. |
| | |
| | The data fields affected are: |
| | Abends, CPUTime, Lifetime, SuspTime, WTRTime, |
| | FileTime, IRate, ICount, CEAPM |
+------------------+--------------------------------------------------+
| INTERVAL | Display transaction metrics based on the data |
| | collected during the current data collection |
| | interval. |
| | |
| | The data fields affected are: |
| | Abends, CPUTime, Lifetime, SuspTime, WTRTime, |
| | FileTime, IRate, ICount, CEAPM |
+------------------+--------------------------------------------------+
| TOTAL | Display transaction metrics based on the data |
| | collected since the data collector was started. |
| | |
| | The data fields affected are: |
| | Abends, CPUTime, Lifetime, SuspTime, WTRTime, |
| | FileTime, IRate, ICount, CEAPM |
+------------------+--------------------------------------------------+
| GRPSONLY | Display only transaction group entries. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+
| Options | Lists the current effective options. These |
| | options can be the original initial defaults, |
| | defaults overridden with the OPTIONS subcommand, |
| | or options specified on the CTRANS command. |
+------------------+--------------------------------------------------+
| Interval | A transaction summary interval. |
| | This value is only displayed if mode = REGION. |
+------------------+--------------------------------------------------+
| Elapsed | The elapsed time in the current interval. |
| | This value is only displayed if mode = REGION. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Tran,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname that owns the transaction. |
+------------------+--------------------------------------------------+
| Tran | The transaction ID or transaction group name. |
| | A transaction group will begin with the "]" |
| | character. |
+------------------+--------------------------------------------------+
| Count | The number of transactions executed since the |
| | start of the SYSVIEW for CICS data collector. |
| | |
| | The count includes those transactions that |
| | were excluded from statistical averaging due |
| | to excessive life time values. |
+------------------+--------------------------------------------------+
| Attaches | The number of transactions attached since the |
| | last CICS statistics reset (STATINT). |
+------------------+--------------------------------------------------+
| Abends | The number of times the transaction generated |
| | an abend during the requested interval. |
+------------------+--------------------------------------------------+
| Program | The initial program to be executed. |
+------------------+--------------------------------------------------+
| Pri | The assigned priority of the transaction. |
| | This field can be modified. |
+------------------+--------------------------------------------------+
| CPUTime | The average CPU time used during the requested |
| | interval. |
| | |
| | The status is based on exception rules for |
| | metric: CICS_TRAN_TASK_CpuTime |
+------------------+--------------------------------------------------+
| Lifetime | The average lifetime during the requested |
| | interval. |
| | |
| | The status is based on exception rules for |
| | metric: CICS_TRAN_CICS_LifeTime |
+------------------+--------------------------------------------------+
| SuspTime | The average time suspended during the requested |
| | interval. |
| | |
| | The status is based on exception rules for |
| | metric: CICS_TRAN_TASK_SuspendTime |
+------------------+--------------------------------------------------+
| WTRTime | The average time waiting to run during the |
| | requested interval. |
| | |
| | The status is based on exception rules for |
| | metric: CICS_TRAN_TASK_WTRTIme |
+------------------+--------------------------------------------------+
| FileTime | The average time spent processing file requests |
| | during the requested interval. |
| | |
| | The status is based on exception rules for |
| | metric: CICS_TRAN_FILE_IoWait |
+------------------+--------------------------------------------------+
| IRate | Transaction throughput rate during the |
| | requested interval. |
| | Units = transactions/second |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| ICount | The number of transactions executed during the |
| | requested interval. |
| | |
| | The count includes those transactions that |
| | were excluded from statistical averaging due |
| | to excessive life time values. |
+------------------+--------------------------------------------------+
| Stgv | The number of storage violations. |
+------------------+--------------------------------------------------+
| CEAPM | The number of CEAPM traced transactions. |
+------------------+--------------------------------------------------+
| TWASize | The size of the transaction work area. |
+------------------+--------------------------------------------------+
| ReadTOV | The read timeout value in seconds. |
+------------------+--------------------------------------------------+
| DeadLock | The deadlock timeout value. |
+------------------+--------------------------------------------------+
| Runaway | The runaway timeout value. |
+------------------+--------------------------------------------------+
| DataLoc | The default location of the data for the task. |
| | Possible values are: |
| | |
| | ANY |
| | BELOW |
+------------------+--------------------------------------------------+
| DataKey | The data key. |
| | Possible values are: |
| | |
| | CICS |
| | USER |
+------------------+--------------------------------------------------+
| Isolate | The transaction isolation. |
+------------------+--------------------------------------------------+
| Disabled | Specifies the transaction has been disabled. |
+------------------+--------------------------------------------------+
| Remote | The CICS transaction ID to be executed on a |
| | remote system. |
+------------------+--------------------------------------------------+
| SysID | The ID of CICS system where the transaction is |
| | to be routed. |
+------------------+--------------------------------------------------+
| TClass | The transaction class. |
+------------------+--------------------------------------------------+
| Profile | The name of the terminal profile to use. |
+------------------+--------------------------------------------------+
| TXD | The address of the TXD_STATIC control block. |
+------------------+--------------------------------------------------+
| Bridge | The 3270 Bridge exit name. |
+------------------+--------------------------------------------------+
| Alias | The alias transaction name. |
+------------------+--------------------------------------------------+
| SPurge | Specifies if the transaction is initially |
| | system purgeable. |
+------------------+--------------------------------------------------+
| TPurge | Specifies if a transaction can be purged because |
| | of a terminal error. |
+------------------+--------------------------------------------------+
| Elapsed | The elapsed time since the transaction ID was |
| | last started. |
+------------------+--------------------------------------------------+
| LastDate | The last date and time that the transaction ID |
| LastTime | was started. |
+------------------+--------------------------------------------------+
| DefGroup | The name of the definition group from where |
| | the entry was installed. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DISable | Disables the transaction so that it is not |
| | available for use. |
| | This function is equivalent to: |
| | |
| | CEMT SET TRAN(tran) DISABLE |
+------------------+--------------------------------------------------+
| ENAble | Enables the transaction so that it is available |
| | for use. |
| | This function is equivalent to: |
| | |
| | CEMT SET TRAN(tran) ENABLE |
+------------------+--------------------------------------------------+
| NEWcopy | Requests a new copy of the program to be loaded. |
| NC | |
+------------------+--------------------------------------------------+
| NOSpurge | Sets the transaction to not be purgeable. |
| | This function is equivalent to: |
| | |
| | CEMT SET TRAN(tran) NOTPURGEABLE |
+------------------+--------------------------------------------------+
| SPurge | Sets the transaction to be purgeable. |
| | This function is equivalent to: |
| | |
| | CEMT SET TRAN(tran) PURGEABLE |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DEG | Invokes the CWAITS command to show degradation |
| | analysis for the selected transaction. |
+------------------+--------------------------------------------------+
| LIFE | Invokes the CLIFE command to show lifetime |
| | analysis for the selected transaction. |
+------------------+--------------------------------------------------+
| PROFile | Invokes the CPROFILE command selecting the |
| | transactions profile name. |
+------------------+--------------------------------------------------+
| PROGram | Invokes the CPROGRAM command selecting the |
| | transactions initial program. |
+------------------+--------------------------------------------------+
| PUse | Invokes the CPROGUSE command to display program |
| | usage for the selected transaction. |
+------------------+--------------------------------------------------+
| Select | Invokes the CTRANLOG command selecting the |
| | jobname and transaction. |
+------------------+--------------------------------------------------+
| STatus | Invokes the CSTATUS command for transaction |
| | summary status. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| OPTions | Set and display command options. |
+------------------+--------------------------------------------------+

OPTIONS Subcommand

Use the OPTIONS subcommand to set and display CTRANS command display
and processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [options] |
+---------------+-----------------------------------------------------+

OPTIONS Parameter Values

The following table lists and explains the valid OPTIONS parameter
values. Any number of the values can be specified in any order.
The current settings of all options are always displayed in
response to the OPTIONS subcommand.

+------------------+--------------------------------------------------+
| Value | Explanation |
+------------------+--------------------------------------------------+
| SYSINTERVAL | Display transaction metrics based on the data |
| | collected during the current transaction summary |
| | interval. |
+------------------+--------------------------------------------------+
| INTERVAL | Display transaction metrics based on the data |
| | collected during the current data collection |
| | interval. |
+------------------+--------------------------------------------------+
| TOTAL | Display transaction metrics based on the data |
| | collected since the data collector was started. |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC |
| | variable. The variable created or updated is |
| | named SYSV_OPTIONS_CTRANS. |
| | |
| | EXTRACT is only valid when the product is |
| | running under a TSO CLIST or REXX exec. |
| | EXTRACT can be specified alone or in combination |
| | with any other OPTIONS keywords. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CTRANS command security


CTRANSUM

CTRANSUM Command

The CTRANSUM command displays CICS transaction summary records.

A log can potentially contain a very large number of records. For


this reason, only the specified number of records will be displayed.
This set of records is referred to as the "display window", and is
controlled by the LINES parameter on the command or the LINES
parameter on the OPTIONS subcommand.

Command Syntax

+------------------+--------------------------------------------------+
| | |
| &HelpMember | [ STREAM logstream ] |
| | |
| | [ DATE * | date ] |
| | [ TIME * | time ] |
| | |
| | [ READNext ] |
| | [ READPrev ] |
| | |
| | [ PERiod hh:mm:ss ] |
| | [ CUSHion hh:mm:ss ] |
| | |
| | [ LINEs datalines ] |
| | [ LIMit readlimit ] |
| | [ ELAPsedlimit hh:mm:ss ] |
| | |
| | [ RECtime END | START ] |
| | |
| | [ DISCARD ] |
| | [ NODISCARD ] |
| | |
| | [ FILTER ] |
| | [ NOFILTER ] |
| | |
| | [ GROUP group ] |
| | [ JOBName jobname ] |
| | [ TRAN tran ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| STREAM logstream | Specifies the log stream name from which to |
| | display data. |
| | |
| | If no log stream name is specified, the parmlib |
| | member LGLOOKUP will be used to locate a |
| | matching log stream name. |
| | |
| | Use the following "short" names to substitute |
| | the default log stream name for the indicated |
| | record type: |
| | |
| | AUDIT - Audit events |
| | CICSEITL - CICS EXEC interface trace log |
| | CICSSYSD - CICS system interval analysis |
| | CICSTRAN - CICS transaction log |
| | CICSTSUM - CICS transaction summary log |
| | CICSXLOG - CICS exception log |
| | CTGLOG - CICS Transaction Gateway log |
| | IMSIMTR - IMS transaction log |
| | IMSIMRS - IMS region summary log |
| | IMSIMTS - IMS transaction summary log |
| | IMSOMAT - IMS OM audit trail log |
| | MQSDATA - MQ request history log |
| | OPERLOG - Operations log stream |
| | PLOTLOG - Historical plot log |
| | SMFDATA - SMF log |
| | XLOG - Exception log |
| | ZCNRLOG - z/OS Connect request log |
| | |
+------------------+--------------------------------------------------+
| DATE date | Position to specified date in log. |
| | Read records from the starting point in a |
| | forward direction ( youngest to newest ). |
| | |
| | date - The date value must be specified |
| | using the date format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | Query current date format |
| | |
| | * - Use the current date (today). |
| | |
| | -days - Position to today's date |
| | minus the specified number |
| | of days. |
| | |
| | If a DATE value is supplied and a TIME |
| | value is not supplied, the current TIME (now) |
| | will be used. |
| | |
+------------------+--------------------------------------------------+
| TIME time | Position to specified time in log. |
| | |
| | time - The time value must be specified |
| | using the time format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | Query current time format |
| | |
| | * - Use the current time (now). |
| | |
| | nnAM - The time value can also be |
| | nnPM specified using one of the |
| | following values: |
| | 12AM | 1AM | 2AM | ... | 11AM |
| | 12PM | 1PM | 2PM | ... | 11PM |
| | NOON | MIDNIGHT |
| | |
| | -adjust - Set the time value to the |
| | +adjust current time (now) plus or minus |
| | the specified adjustment value. |
| | |
| | Example adjustment values: |
| | |
| | -0.500000 - 0.5 seconds |
| | -60 - 60 seconds |
| | -120Sec - 120 seconds |
| | -5MINutes - 5 minutes |
| | -1Hours - 1 hour |
| | -1Days - 1 day |
| | -hh:mm:ss - hours:minutes:seconds |
| | |
| | +0.500000 + 0.5 seconds |
| | +60 + 60 seconds |
| | +120Sec + 120 seconds |
| | +5MINutes + 5 minutes |
| | +1Hours + 1 hour |
| | +1Days + 1 day |
| | +hh:mm:ss + hours:minutes:seconds |
| | |
| | If a TIME value is supplied and a DATE |
| | value is not supplied, the current DATE |
| | will be used. |
| | |
+------------------+--------------------------------------------------+
| READPrev | If a date or time value is specified, READPREV |
| | specifies that the log is to be read starting |
| | at the date and time and read backwards |
| | (youngest to oldest). |
| | |
| | If date or time is not specified, the READPREV |
| | parameter is ignored. |
| | |
+------------------+--------------------------------------------------+
| READNext | If a date or time value is specified, READNEXT |
| | specifies that the log is to be read starting |
| | at the date and time and read forwards |
| | (oldest to youngest). |
| | |
| | If date or time is not specified, the READNEXT |
| | parameter is ignored. |
| | |
+------------------+--------------------------------------------------+
| PERiod hh:mm:ss | Specifies the time period for which records are |
| | to be displayed. |
| | |
| | Default : 0 (unlimited) |
| | |
| | Example values: |
| | |
| | NONE - No period (unlimited) |
| | 0 - No period (unlimited) |
| | 0.500000 - 0.5 seconds |
| | 60 - 60 seconds |
| | 120Sec - 120 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | 1Days - 1 day |
| | 1MONths - 1 month |
| | 1Years - 1 year |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| CUSHion hh:mm:ss | Specifies the time period cushion for which |
| | records are to be read for display. |
| | |
| | Data records stored in an MVS log stream are |
| | sequenced or sorted based on the actual time |
| | the record was written to the stream. |
| | |
| | This does not guarantee that the records are |
| | sorted in a time sequence based on the |
| | date and time information that is potentially |
| | contained within each record. |
| | |
| | For this reason, when a user wants to display |
| | a specific time period of data, additional |
| | records must be read on the front and back |
| | end of the read process to ensure that the |
| | records that might be out of sequence are |
| | included. |
| | |
| | The time period cushion specifies the extra |
| | records to be read. |
| | |
| | Example Cushion: |
| | |
| | Start time: 8AM |
| | Period : 1 Hour |
| | Cushion : 5 minutes |
| | |
| | Read Begin : 07:55:00 |
| | -- Discard records |
| | Display Begin : 08:00:00 |
| | -- Display records |
| | Display End : 09:00:00 |
| | -- Discard records |
| | Read End : 09:05:00 |
| | |
| | Example values: |
| | |
| | NONE - No cushion |
| | 0 - No cushion |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| LINEs count | Specifies the maximum number of data rows to |
| | be displayed. |
| | |
| | Default : 25000 |
| | Minimum : 1 |
| | Maximum : 1000000 |
| | |
| | Specifying the LINES value with the primary |
| | command syntax does not alter or change the |
| | default value stored in the user profile. |
| | |
| | The default value can be altered using the |
| | subcommand: OPTIONS LINES count |
| | |
| | The actual number of data rows displayed may |
| | be greater than the specified LINES value if |
| | a record or message expanded to multiple lines. |
| | |
+------------------+--------------------------------------------------+
| LIMit count | Specifies the maximum number of records to be |
| | read. |
| | |
| | Specifying the LIMIT value with the primary |
| | command syntax does not alter or change the |
| | default value stored in the user profile. |
| | |
| | The default value can be altered using the |
| | subcommand: OPTIONS LIMIT count |
| | |
| | Default : 1000000 |
| | |
+------------------+--------------------------------------------------+
| ELAPsed hh:mm:ss | Specifies the elapsed time limit for reading |
| | or searching the log streams for desired |
| | data. |
| | |
| | If the log stream being searched is very large, |
| | the search time required can be substantial. |
| | This is especially true if a large number |
| | of data LINES has been requested and the |
| | number of data records that would satisfy |
| | the search request are spread across the |
| | entire log stream. |
| | |
| | The log browse search will be interrupted |
| | when the elapsed time limit is reached. |
| | |
| | The search can be continued using the |
| | subcommands: NEXT or PREVIOUS |
| | |
| | Example values: |
| | |
| | NONE - No timeout |
| | 0 - No timeout |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| RECORDTime | Specifies whether the "start" or "end" date |
| RECTime | and time should be used for the records. |
| | |
| | Not all records have a start and an end |
| | time. Records that do not have both a start |
| | and an end time are considered "events". |
| | |
| | Records that are interval based typically |
| | do have a start and end time. |
| | |
| | Records that are event based typically do not. |
| | |
| | Valid values: |
| | |
| | END |
| | START |
| | EVENT |
| | |
+------------------+--------------------------------------------------+
| DISCard | Specifies whether records found to be in the |
| NODISCard | time period cushion should be discarded or |
| | kept. |
| | |
| | DISCARD - Discard the records found in |
| | the cushion. (default) |
| | |
| | NODISCARD - Keep the records found in the |
| | cushion. |
| | |
+------------------+--------------------------------------------------+
| FILTER | Display a "filter" screen to allow the |
| NOFILTER | entering of command syntax parameters to |
| | filter the data. |
| | |
| | When the "FILTER" keyword is entered as part |
| | of the primary command, the parameters entered |
| | will be used to populate the filter display. |
| | |
| | After entering desired data on the filter |
| | display, the following function keys can |
| | be used: |
| | |
| | ENTER - Validate the data entered. |
| | No processing occurs. |
| | |
| | F1 - Invoke HELP for the filter display. |
| | |
| | F3 - Validate the data entered and |
| | process the data to build the |
| | display. |
| | |
| | F12 - Do not validate data. No processing |
| | occurs. The existing data is |
| | redisplayed. |
| | |
| | FILTER - Display filter. |
| | |
| | NOFILTER - Do not display filter (default). |
| | |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| GROUP | Specifies a logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames to be |
| | displayed. |
| | |
| | Syntax: GROUP group |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used as the |
| | default. |
| | |
| | The current profile setting can be viewed using |
| | the following: QUERY CICSGROUP |
| | |
| | The list of CICSPLEX groups can be found on |
| | GROUPS command. |
+------------------+--------------------------------------------------+
| JOBName | Specifies the jobname that is to be displayed. |
| | |
| | The jobname can be specified as: |
| | * Specific jobname |
| | * Generic jobname |
| | * Logical group name containing a list of |
| | of CICS jobnames. |
| | Logical group type = CICSPLEX |
| | Syntax: ]group |
| | |
| | Syntax: JOBNAME jobname |
+------------------+--------------------------------------------------+
| TRAN | Specifies the transaction that is to be |
| | displayed. The "Tran" field will be examined |
| | for a match. |
| | |
| | The transaction can be specified as: |
| | * Specific transaction ID |
| | * Generic transaction ID |
| | * Logical group name containing a list of |
| | of CICS transactions. |
| | Logical group type = CICSTRAN |
| | Syntax: ]group |
| | |
| | Syntax: TRAN tran |
| | Generic or wildcard characters can be used. |
+------------------+--------------------------------------------------+

Information Fields

The Information Section area is cursor selectable.


If the cursor is in the Information Section and the [ENTER] key
is pressed, the "FILTER" panel will be displayed.

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| LogStream | The name of the log stream from which data |
| | is being displayed. |
| | |
| | The keyword "ASIS" will follow the log stream |
| | name if the records are being read ASIS. |
| | ASIS specifies that no record decompression |
| | has been requested. |
+------------------+--------------------------------------------------+
| Retention | The log stream retention period. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Available | The time and date of the first and last records |
| | in the physical log stream. |
| | |
| | Commands that display the contents of log |
| | streams will only display those records that |
| | are relevant to the specific command. The log |
| | stream may contain other records. |
| | |
| | The available time and date information may not |
| | reflect the actual usable data records if the |
| | log stream contains data different than what |
| | corresponds to the active command. |
+------------------+--------------------------------------------------+
| Searched | The searched range of records processed. |
+------------------+--------------------------------------------------+
| Displayed | The current "display window" of records being |
| | displayed. |
| | |
| | The time and date of the first and last records |
| | displayed. |
| | |
| | This value can be modified to position to a new |
| | starting time and date. |
+------------------+--------------------------------------------------+

+------------------+--------------------------------------------------+
| Lines | Specifies the maximum number of data rows |
| | to be displayed. |
+------------------+--------------------------------------------------+
| Limit | Specifies the maximum number of records to be |
| | read in order to satisfy the specified "Lines" |
| | value. |
| | The value "NONE" indicates that no limit or |
| | "0" was specified. |
+------------------+--------------------------------------------------+
| Period | Specifies the time period for which records are |
| | to be displayed. |
| | The value "NONE" indicates that no time period |
| | was specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: Date,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Date | The end date of the interval. |
+------------------+--------------------------------------------------+
| Time | The end time of the interval. |
+------------------+--------------------------------------------------+
| Tran | The name of the transaction. |
| | |
| | If the transaction name is "*", the entry |
| | is a summary of all transactions for the |
| | interval. |
| | |
| | If the transaction name begins with "]", the |
| | entry is a summary of transactions defined to |
| | the logical group "]group". |
| | |
+------------------+--------------------------------------------------+
| Count | The number of transactions executed. |
| | |
| | The count includes those transactions that |
| | were excluded from statistical averaging due |
| | to excessive life time values. |
+------------------+--------------------------------------------------+
| Rate | The number of transactions per minute. |
+------------------+--------------------------------------------------+
| Abends | The total number of abends. |
+------------------+--------------------------------------------------+
| Lifetime | The average lifetime of a transaction. |
+------------------+--------------------------------------------------+
| CPUTime | The average CPUTIME used by a transaction. |
+------------------+--------------------------------------------------+
| DispTime | The average Dispatch time |
+------------------+--------------------------------------------------+
| Suspend | The average suspend time |
+------------------+--------------------------------------------------+
| EXWTime | The average CICS exception wait time |
+------------------+--------------------------------------------------+
| DspDelay | The average dispatch delay time - 1st |
+------------------+--------------------------------------------------+
| FCPTime | The average file I/O wait time |
+------------------+--------------------------------------------------+
| MROTime | The average inter-region wait time |
+------------------+--------------------------------------------------+
| MxTDelay | The average MXT delay 1st dispatch |
+------------------+--------------------------------------------------+
| RMITIME | The average Resource Manager Interface |
+------------------+--------------------------------------------------+
| RMISUSP | The average Resource Manager Suspend |
+------------------+--------------------------------------------------+
| TermTime | The average terminal I/O wait time |
+------------------+--------------------------------------------------+
| TCLDelay | The average tran class delay 1st disp |
+------------------+--------------------------------------------------+
| RMITOTAL | The average RMI time - Total |
+------------------+--------------------------------------------------+
| RMICPSM | The average RMI time - CICSPlex SM |
+------------------+--------------------------------------------------+
| RMIDBCTL | The average RMI time - DBCTL |
+------------------+--------------------------------------------------+
| RMIDB2 | The average RMI time - DB2 |
+------------------+--------------------------------------------------+
| RMIEXDLI | The average RMI time - EXEC DLI |
+------------------+--------------------------------------------------+
| RMIMQM | The average RMI time - MQ |
+------------------+--------------------------------------------------+
| RMIOTHER | The average RMI time - Other |
+------------------+--------------------------------------------------+
| RMITCPIP | The average RMI time - TCP/IP sockets |
+------------------+--------------------------------------------------+
| WTRTime | The average waiting to run time |
+------------------+--------------------------------------------------+
| GSVITIME | The average global user exit monitor time |
+------------------+--------------------------------------------------+
| GSVICPU | The average global user exit cpu time |
+------------------+--------------------------------------------------+
| Interval | The length of the system interval. |
+------------------+--------------------------------------------------+
| IOCount | The number of I/Os executed. |
+------------------+--------------------------------------------------+
| Umbrella | The name of the umbrella transaction. |
+------------------+--------------------------------------------------+
| Length | The record length. |
+------------------+--------------------------------------------------+
| BlockID | Block ID assigned to the log record. |
+------------------+--------------------------------------------------+
| SubRec | Sub-record number within a block. |
+------------------+--------------------------------------------------+
| CmpLen | Length of the compressed record |
+------------------+--------------------------------------------------+
| Cmp% | Compression percentage |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DRO | Delete records older than the entry selected. |
| | Invokes the LGDRO command. |
+------------------+--------------------------------------------------+
| PRint | Displays the detail screen for a record, prints |
| | the detail report to a sysout data set and then |
| | returns to the display screen. If a SYSOUT |
| | print data set was not open this line command |
| | will cause it to be opened. All subsequent |
| | PRINT line commands will print to the same |
| | SYSOUT data set until a PRINT CLOSE command is |
| | issued or until the session terminates. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Dump | Dump the contents of a record. |
+------------------+--------------------------------------------------+
| SD | Select and dump. |
| | |
| | A detailed report followed by a dump of the |
| | contents of the record is displayed. |
+------------------+--------------------------------------------------+
| Select | Display the detail screen for a record. |
| | Detail report information |
+------------------+--------------------------------------------------+

Subcommands
+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| BACkward | Read the previous block of records in the log |
| PREVious | starting with the first record displayed on the |
| | screen. The number of records read is |
| | controlled by the LINES option, which can be set |
| | using the OPTIONS subcommand. |
+------------------+--------------------------------------------------+
| EOF | Go to the end of the log. |
| EOL | |
+------------------+--------------------------------------------------+
| FORward | Read the next block of records in the log |
| NEXT | starting with the last record displayed on the |
| | screen. The number of records read is |
| | controlled by the LINES option, which can be set |
| | using the OPTIONS subcommand. |
+------------------+--------------------------------------------------+
| OPTions | Set and display miscellaneous command options. |
+------------------+--------------------------------------------------+
| POSition | Position to a time and date. |
| | |
| | Syntax : POSITION time [date] |
| | |
| | time - The time value must be specified |
| | using the time format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | If "*" is specified, the current |
| | time will be used. |
| | |
| | The time value can also be |
| | specified using one of the |
| | following values: |
| | 12AM | 1AM | 2AM | ... | 11AM |
| | 12PM | 1PM | 2PM | ... | 11PM |
| | NOON | MIDNIGHT |
| | |
| | Query current time format |
| | |
| | date - The date value must be specified |
| | using the date format of the user |
| | as specified in the profile for |
| | the current command. |
| | |
| | If "*" is specified, the current |
| | date will be used. |
| | |
| | Query current date format |
| | |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| TOF | Go to the top of the log. |
| TOL | |
+------------------+--------------------------------------------------+
| FILTER | Display a "filter" screen to allow the entering |
| | command syntax parameters to filter the data. |
+------------------+--------------------------------------------------+
OPTIONS Subcommand

The OPTIONS subcommand sets and displays miscellaneous command


options.

Entering the OPTIONS subcommand with no parameters displays the


current option values.

Multiple option values can be entered as a single command.

OPTIONS Subcommand format

+------------------+--------------------------------------------------+
| OPTIONS | [options] |
+------------------+--------------------------------------------------+

OPTIONS Subcommand Parameter Values

+------------------+--------------------------------------------------+
| Value | Explanation |
+------------------+--------------------------------------------------+
| LINEs | Specifies the maximum number of data rows to |
| | be displayed. |
| | |
| | Syntax : OPTIONS LINES count |
| | |
| | Default : 25000 |
| | Minimum : 1 |
| | Maximum : 1000000 |
| | |
+------------------+--------------------------------------------------+
| LIMit | Specifies the maximum number of records to be |
| | read. |
| | |
| | Syntax : OPTIONS LIMIT count |
| | |
| | Default : 1000000 |
| | |
+------------------+--------------------------------------------------+
| PERiod | Specifies the time period for which records are |
| | to be displayed. |
| | |
| | Syntax : OPTIONS PERIOD hh:mm:ss |
| | |
| | Default : 0 (unlimited) |
| | |
| | Example values: |
| | |
| | NONE - No period (unlimited) |
| | 0 - No period (unlimited) |
| | 0.500000 - 0.5 seconds |
| | 60 - 60 seconds |
| | 120Sec - 120 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | 1Days - 1 day |
| | 1MONths - 1 month |
| | 1Years - 1 year |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| CUSHion | Specifies the time period cushion for which |
| | records are to be read for display. |
| | |
| | Data records stored in an MVS log stream are |
| | sequenced or sorted based on the actual time |
| | the record was written to the stream. |
| | |
| | This does not guarantee that the records |
| | are sorted in a time sequence based on the |
| | date and time information that is potentially |
| | contained within each record. |
| | |
| | For this reason, when a user wants to display |
| | a specific time period of data, additional |
| | records must be read on the front and back |
| | end of the read process to ensure that the |
| | records that might be out of sequence are |
| | included. |
| | |
| | The time period cushion specifies the extra |
| | records to be read. |
| | |
| | Syntax : OPTIONS CUSHION hh:mm:ss |
| | |
| | Example Cushion: |
| | |
| | Start time: 8AM |
| | Period : 1 Hour |
| | Cushion : 5 minutes |
| | |
| | Read Begin : 07:55:00 |
| | -- Discard records |
| | Display Begin : 08:00:00 |
| | -- Display records |
| | Display End : 09:00:00 |
| | -- Discard records |
| | Read End : 09:05:00 |
| | |
| | Example values: |
| | |
| | NONE - No cushion |
| | 0 - No cushion |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| ELAPsed | Specifies the elapsed time limit for reading |
| ELAPsedlimit | or searching the log streams for desired data. |
| | |
| | If the log stream being searched is very large, |
| | the search time required can be substantial. |
| | This is especially true if a large number of |
| | data LINES has been requested and the number |
| | of data records that would satisfy the search |
| | request are spread across the entire log stream. |
| | |
| | The log browse search will be interrupted |
| | when the elapsed time limit is reached. |
| | |
| | The search can be continued using the |
| | subcommands: NEXT or PREVIOUS |
| | |
| | Syntax : OPTIONS ELAPSED hh:mm:ss |
| | |
| | Default : 00:00:30 |
| | |
| | Example values: |
| | |
| | NONE - No limit |
| | 0 - No limit |
| | 10 - 10 seconds |
| | 5MINutes - 5 minutes |
| | 1Hours - 1 hour |
| | hh:mm:ss - hours:minutes:seconds |
| | |
+------------------+--------------------------------------------------+
| RECORDTime | Specifies whether the "start" or "end" date |
| RECTime | and time should be used for the records. |
| | |
| | Not all records have a start and an end time. |
| | |
| | Records that are interval based typically do |
| | have a start and end time. |
| | |
| | Records that are event based typically do not. |
| | |
| | Syntax : OPTIONS RECTIME END|START |
| | |
| | Valid values are: |
| | |
| | END (default) |
| | START |
| | |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC |
| | variable. The variable created or updated is |
| | named SYSV_OPTIONS_cmdname. EXTRACT is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. EXTRACT can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+------------------+--------------------------------------------------+
| FILTER | Specifies that the "filter" display screen |
| | is to be displayed to allow the entering of |
| | command syntax parameters. |
| | |
| | The "filter" display screen will be displayed |
| | each time the command is invoked unless the |
| | NOFILTER parameter is entered as part of the |
| | primary command syntax. |
| | |
| | Syntax : OPTIONS FILTER |
| | |
+------------------+--------------------------------------------------+
| NOFILTER | Specifies that the "filter" display screen |
| | is not to be displayed. |
| | |
| | The NOFILTER option can be overridden by |
| | entering the FILTER parameter as part of the |
| | primary command syntax. |
| | |
| | The subcommand FILTER can also be used to |
| | display the "filter" display screen. |
| | |
| | Syntax : OPTIONS NOFILTER |
| | |
+------------------+--------------------------------------------------+
| RESET | Request to option values to the defaults. |
| | |
| | Syntax : OPTIONS RESET |
| | |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Related Information

SYSVIEW Usage of MVS Log Streams

Security Requirements

The display of log record information can be controlled by security


definitions. The number of security calls can be large. Two security
calls are made for each log record to verify the authorization to
display the jobname and transaction ID. The security checks are also
performed if the log record is selected for detailed display.

To enable security validation for CICS log displays, set the following
options in the parmlib member:

sysview.CNM4BPRM(OPTIONS)

SECURE-CICSLOG-BY-JOBNAME Yes
SECURE-CICSLOG-BY-TRAN Yes

For security requirements, follow the link:

CTRANSUM command security


CTSDSTAT

CTSDSTAT Command

The CTSDSTAT command displays statistical information for


Time Series Data generated and sent for analytics processing.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTSDSTAT | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
| | [ ENABLE | DISABLE ] |
| | [ BYPASS | NOBYPASS ] |
| | |
+------------------+--------------------------------------------------+
Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
| ENABLE | Enable Time Series Data collection. |
| | |
| | This is a main switch that overrides all |
| | individual collections. |
+------------------+--------------------------------------------------+
| DISABLE | Disable Time Series Data collection. |
| | |
| | This is a main switch that overrides all |
| | individual collections. |
+------------------+--------------------------------------------------+
| BYPASS | Sets the status of the component to bypass write |
| | requests to the CCS Data Mover. |
| | |
| | When in bypass mode, all categories will also |
| | bypass writes to the CCS Data Mover. |
| | |
| | The data collection for specific categories will |
| | continue to be collected if enabled and there is |
| | an active subscription. |
| | |
| | Bypassing the write process can be useful in the |
| | determination of data volume and throughput |
| | without actually sending the data. |
+------------------+--------------------------------------------------+
| NOBYPASS | Sets the status of the component to not bypass |
| | write requests to the CCS Data Mover. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+
| Status | The overall status of Time Series Data. |
| | |
| | Possible values are: |
| | |
| | ENABLED - Time Series Data collection is |
| | enabled. |
| | |
| | DISABLED - Time Series Data collection is |
| | disabled. |
| | |
| | DISABLET - Time Series Data collection is |
| | disabled for the collection |
| | category. |
| | See the TSDSTATS command for more |
| | details. |
+------------------+--------------------------------------------------+
| Bypass | The bypass status indicating if collected data |
| | will be sent to the CCS Data Mover. |
| | |
| | Possible values are: |
| | |
| | NOBYPASS - Data collected will be sent to |
| | the CCS Data Mover. |
| | |
| | BYPASS - Data collected will not be sent to |
| | the CCS Data Mover. |
| | |
| | BYPASST - Writes are bypassed for the |
| | category type TSD. |
| | |
| | BYPASSG - Data collected will not be sent to |
| | the CCS Data Mover. |
| | The data is being bypassed globally|
| | for all collection categories. |
| | |
| | See the ZDMSTATS command for more details. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Collection,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Collection | The name of the collection of metrics. |
+------------------+--------------------------------------------------+
| Status | The collection status. Indicates whether Time |
| | Series Data is currently being collected for the |
| | collection. |
| | |
| | Possible values are: |
| | |
| | ACTIVE - Collection is active |
| | |
| | INACTIVE - Collection is inactive |
| | |
| | NOCONN - Collection is inactive due to |
| | no connection to the data mover. |
| | |
| | NOFEAT - Collection is inactive. The |
| | associated product feature is |
| | inactive. |
+------------------+--------------------------------------------------+
| Schedule | The scheduled event status. The collection of |
| | the data occurs during a data collection process |
| | driven by the Event Scheduler. This value |
| | indicates whether the "Scheduled Event" is |
| | currently active. |
| | |
| | Possible values are: |
| | |
| | ACTIVE - Scheduled event is active. |
| | |
| | INACTIVE - Scheduled event is inactive. |
| | |
| | TSKINACT - Scheduled event is inactive due to |
| | the data collection subtask being |
| | inactive. |
+------------------+--------------------------------------------------+
| Enabled | Indicates whether the collection has been |
| | specified as enabled for collection. |
| | |
| | Possible values are: |
| | |
| | ENABLED - The collection is enabled. |
| | |
| | DISABLED - The collection is disabled. |
| | |
| | DISABLES - The collection is disabled at |
| | the system level. |
| | |
| | DISABLET - The collection is disabled at |
| | the collection category type |
| | level. |
| | |
| | DISABLEG - The collection is disabled at |
| | the global level. |
| | |
| | See the TSDSTATS command for more details. |
+------------------+--------------------------------------------------+
| Subscribe | Indicates whether the collection has a current |
| | subscriber. |
| | |
| | Possible values are: |
| | |
| | blank - No subscription is active. |
| | |
| | SUBSCRIBE - Subscription has been requested. |
+------------------+--------------------------------------------------+
| Bypass | Indicates if data writes to the |
| | CCS Data Mover are to be bypassed for the |
| | category. |
| | |
| | Possible values are: |
| | |
| | blank - Writes are not bypassed. |
| | |
| | BYPASS - Writes are bypassed for the |
| | category. |
| | |
| | BYPASST - Writes are bypassed for the |
| | category type. |
| | |
| | BYPASSG - Writes are bypassed globally |
| | for all categories. |
+------------------+--------------------------------------------------+
| Packets | Total packets created. |
+------------------+--------------------------------------------------+
| Buffers | Total buffers allocated. Multiple buffers may |
| | be allocated per packet. |
+------------------+--------------------------------------------------+
| BytesSent | Total bytes sent. |
+------------------+--------------------------------------------------+
| BytesMax | Maximum bytes sent in one packet. |
+------------------+--------------------------------------------------+
| ObjectsAvg | Average number of metric group objects |
| | generated per packet. |
+------------------+--------------------------------------------------+
| ObjectsTotal | Total number of metric group objects generated. |
+------------------+--------------------------------------------------+
| MetricsAvg | Average number of metrics per packet. |
+------------------+--------------------------------------------------+
| MetricsTotal | Total number of metrics generated. |
+------------------+--------------------------------------------------+
| Date | Date of last collection. |
+------------------+--------------------------------------------------+
| Time | Time of last collection. |
+------------------+--------------------------------------------------+
| ScheduleEvent | The name of the associated Scheduled Event that |
| | performs the collection of the data. This event |
| | must be active for collection to occur. Some |
| | events may be internal and not available for |
| | external control. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DISable | Disable the collection of data. |
+------------------+--------------------------------------------------+
| ENAble | Enable the collection of data. Collection will |
| | not occur until a subscriber requests the data. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| BYPASS | Sets the status of the component to bypass write |
| | requests to the CCS Data Mover. |
| | |
| | When in bypass mode, all categories will also |
| | bypass writes to the CCS Data Mover. |
| | |
| | The data collection for specific categories will |
| | continue to be collected if enabled and there is |
| | an active subscription. |
| | |
| | Bypassing the write process can be useful in the |
| | determination of data volume and throughput |
| | without actually sending the data. |
+------------------+--------------------------------------------------+
| DISABLE | Disable Time Series Data collection. |
| | |
| | This is a main switch that overrides all |
| | individual collections. |
+------------------+--------------------------------------------------+
| ENABLE | Enable Time Series Data collection. |
| | |
| | This is a main switch that overrides all |
| | individual collections. |
+------------------+--------------------------------------------------+
| NOBYPASS | Sets the status of the component to not bypass |
| | write requests to the CCS Data Mover. |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CTSMODEL

CTSMODEL Command

The CTSMODEL command displays CICS temporary storage model


definitions. These definitions are used to map temporary storage
requests to a temporary storage server using the poolname attribute
of the TSMODEL.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTSMODEL | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Name,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname that owns the entry. |
+------------------+--------------------------------------------------+
| Name | The name of the temporary storage model. |
+------------------+--------------------------------------------------+
| Prefix | The character string to be used as the prefix |
| | for this model entry. |
+------------------+--------------------------------------------------+
| PoolName | The name of the shared TS pool definition. |
+------------------+--------------------------------------------------+
| SysID | The name of the remote system. |
+------------------+--------------------------------------------------+
| RemotePrefix | The character string to be used as the prefix on |
| | the remote system. |
+------------------+--------------------------------------------------+
| Loc | The queue location. This indicates whether the |
| | queue is to be held in auxiliary or main |
| | storage. Valid values are: |
| | |
| | MAIN Main storage |
| | AUX Auxiliary storage |
+------------------+--------------------------------------------------+
| Recover | Specifies whether queues matching this model |
| | definition are to be recoverable. |
+------------------+--------------------------------------------------+
| Security | Specifies whether security checking is to be |
| | performed for queues that match this model |
| | definition. |
+------------------+--------------------------------------------------+
| MDB | The address of the Model Definition Block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CTSMODEL command security


CTSPOOLS

CTSPOOLS Command

The CTSPOOLS command displays CICS temporary storage shared pools


and connection status.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTSPOOLS | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

The following fields are only displayed in REGION mode:


+------------------+--------------------------------------------------+
| Pools Defined | The number of pools defined. |
+------------------+--------------------------------------------------+
| Pools Connected | The number of pools currently connected. |
+------------------+--------------------------------------------------+
| Shared Reads | The number of shared read requests. |
+------------------+--------------------------------------------------+
| Shared Writes | The number of shared write requests. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,PoolName,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname that owns the entry. |
+------------------+--------------------------------------------------+
| PoolName | The name of the shared TS pool. |
+------------------+--------------------------------------------------+
| Requests | The number of requests that have been |
| | made to shared TS queue server. |
+------------------+--------------------------------------------------+
| SysID | The name of the remote system. |
+------------------+--------------------------------------------------+
| Connected | The connection status. Valid values are: |
| | |
| | CONNECTED Pool is connected |
| | FAILED Connection failed |
| | blank Pool is not connected |
+------------------+--------------------------------------------------+
| Server | The jobname of the connected shared TS queue |
| | server. |
+------------------+--------------------------------------------------+
| ASID | The ASID of the connected shared TS queue |
| | server. |
+------------------+--------------------------------------------------+
| Jobnr | The job number of the connected shared TS queue |
| | server. |
+------------------+--------------------------------------------------+
| ConnDate | The date and time that the CICS connected to |
| ConnTime | the shared TS queue server. |
+------------------+--------------------------------------------------+
| LastDate | The date and time of the last request that was |
| LastTime | processed by the shared TS queue server. |
+------------------+--------------------------------------------------+
| STE | The address of the SysID Table Entry. |
+------------------+--------------------------------------------------+
| PCA | The address of the Pool Control Area. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invoke the CTSQUEUE command selecting |
| | queues with a matching "PoolName". |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CTSPOOLS command security


CTSQUEUE

CTSQUEUE Command

The CTSQUEUE command displays the current temporary storage queues.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CTSQUEUE | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Queue,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname owning queue. |
+------------------+--------------------------------------------------+
| Queue | The temporary storage queue ID. |
+------------------+--------------------------------------------------+
| Loc | The temporary storage location. |
| | Possible values are: |
| | |
| | MAIN Storage was allocated from |
| | temporary storage main |
| | AUX Storage was allocated from the |
| | temporary storage auxiliary data |
| | set |
| | CF Coupling facility |
+------------------+--------------------------------------------------+
| Type | The temporary storage type. |
| | |
| | QUEUE Entry is a queue of items |
+------------------+--------------------------------------------------+
| Items | The number of items in the queue. |
+------------------+--------------------------------------------------+
| Size | The total storage in use by the queue. |
+------------------+--------------------------------------------------+
| Segments | The total number of 256-byte shared storage |
| | segments in use if Loc = CF. |
+------------------+--------------------------------------------------+
| Min | The minimum size of a single item on the queue. |
+------------------+--------------------------------------------------+
| Max | The maximum size of a single item on the queue. |
+------------------+--------------------------------------------------+
| Tran | The transaction name that created the queue. |
+------------------+--------------------------------------------------+
| Date | The date the queue was created. |
+------------------+--------------------------------------------------+
| Time | The time the queue was created. |
+------------------+--------------------------------------------------+
| LastRef | The elapsed time since the queue was last |
| | reference. |
+------------------+--------------------------------------------------+
| LastDate | The date the queue was last referenced. |
+------------------+--------------------------------------------------+
| LastTime | The time the queue was last referenced. |
+------------------+--------------------------------------------------+
| PoolName | The associated pool name if the queue resides |
| | in the coupling facility. |
+------------------+--------------------------------------------------+
| ListNum | The associated coupling facility list number. |
+------------------+--------------------------------------------------+
| Structure | The associated coupling facility list structure |
| | name. |
+------------------+--------------------------------------------------+
| Queue-Hex | The temporary storage queue ID in hexadecimal. |
+------------------+--------------------------------------------------+
| TSQUEUE | The address of the TSQUEUE control block. |
| | Not displayed for coupling facility queues. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DELete | Delete the selected temporary storage queue. |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| DUmp | Invoke the DUMP command to display the virtual |
| | storage specified in the TSQUEUE field. |
+------------------+--------------------------------------------------+

Subcommands
+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CTSQUEUE command security


CUOW

CUOW Command

The CUOW command displays the current status of CICS Units Of Work.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CUOW | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

(displayed only in REGION mode)


+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Sync | Specifies the total number of forward commits. |
| Forward | |
+------------------+--------------------------------------------------+
| Sync | Specifies the total number of backward commits. |
| Backward | |
+------------------+--------------------------------------------------+
| Shunted | Specifies the number of unshunts of indoubt |
| Indoubt | units of work. |
+------------------+--------------------------------------------------+
| Shunted | Specifies the number of final unshunts of |
| RO-Fail | backout or commit failed units of work. |
+------------------+--------------------------------------------------+
| Forced | Specifies the number of heuristic decisions |
| Decisions | made. |
+------------------+--------------------------------------------------+
| Time | Specifies the total time that units of work were |
| Indoubt | shunted indoubt. |
+------------------+--------------------------------------------------+
| Time | Specifies the total time that backout or commit |
| RO-Fail | units of work were shunted. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Local-UOW,A,Tran,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Specifies the CICS jobname where the unit of |
| | work resides. |
+------------------+--------------------------------------------------+
| Local-UOW | Specifies the local unit of work ID. |
+------------------+--------------------------------------------------+
| Status | Specifies the current unit of work status. |
| | Possible values are: |
| | |
| | COMMIT |
| | BACKOUT |
| | INDOUBT |
| | INFLIGHT |
| | HCOMMIT |
| | HBACKOUT |
+------------------+--------------------------------------------------+
| WaitState | Specifies if syncpoint processing of the UOW has |
| | been deferred. |
+------------------+--------------------------------------------------+
| Tran | Specifies the associated transaction ID. |
+------------------+--------------------------------------------------+
| Task# | Specifies the CICS task number. |
+------------------+--------------------------------------------------+
| Term | Specifies the terminal ID. |
+------------------+--------------------------------------------------+
| LUName | Specifies the logical unit name. |
+------------------+--------------------------------------------------+
| Age | Specifies the age of the unit of work. This is |
| | the time since the UOW entered its current |
| | state, or since the start of the UOW. |
+------------------+--------------------------------------------------+
| FPProt | Specifies if the unit of work has force purge |
| | protection. |
+------------------+--------------------------------------------------+
| Unit-of-Work-Id | Specifies the remote CICS unit of work ID. |
+------------------+--------------------------------------------------+
| UOW-Token | Specifies the subset of the unit of work. |
+------------------+--------------------------------------------------+
| Seq# | Specifies the sequence number. |
+------------------+--------------------------------------------------+
| Tran-Token | Specifies the transaction token. |
+------------------+--------------------------------------------------+
| RMUW | Specifies the address of the RMUW control block. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| BACkout | Attempt to force syncpoint backout processing |
| | as specified for this UOW. |
+------------------+--------------------------------------------------+
| COMmit | Attempt to force syncpoint commit processing |
| | as specified for this UOW. |
+------------------+--------------------------------------------------+
| FORce | Attempt to force the UOW to backout or commit, |
| | as specified on the ACTION option of the |
| | transaction resource definition. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.

Security Requirements

For security requirements, use the link: CUOW command security


CURIMAPS

CURIMAPS Command

The CURIMAPS command displays URIMAP resource definitions and


associated attributes.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CURIMAPS | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Urimap,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Urimap | Name of the URIMAP definition. |
+------------------+--------------------------------------------------+
| Status | The status of the URIMAP definition. |
| | Possible values are: |
| | ENABLED |
| | DISABLED |
| | HDISABLE |
+------------------+--------------------------------------------------+
| Usage | The usage for URIMAP definition. |
| | Possible values are: |
| | CLIENT |
| | PIPELINE |
| | SERVER |
| | ATOM |
+------------------+--------------------------------------------------+
| Scheme | The scheme component of the URL. |
| | Possible values are: |
| | HTTP |
| | HTTPS |
+------------------+--------------------------------------------------+
| Analyze | The analyzer program setting for the URIMAP |
| | definition. |
| | Possible values are: |
| | blank - The analyzer program is not to be |
| | used. |
| | ANALYZE - The analyzer associated with the |
| | TCPIPSERVICE will be used in |
| | processing the HTTP request. |
+------------------+--------------------------------------------------+
| RedirType | The type of redirection for requests that match |
| | this definition. |
| | Possible values are: |
| | NONE - Requests are not redirected. |
| | PERM - Requests are redirected |
| | permanently. |
| | TEMP - Requests are redirected on a |
| | temporary basis. |
+------------------+--------------------------------------------------+
| TCPIPSvc | The TCPIPSERVICE definition that specifies |
| | the inbound port for this URIMAP definition. |
+------------------+--------------------------------------------------+
| Reference | The number of times located. |
+------------------+--------------------------------------------------+
| Disabled | The number of times found disabled. |
+------------------+--------------------------------------------------+
| Redirect | The number of times redirected. |
+------------------+--------------------------------------------------+
| Tran | The name of an alias transaction to run the |
| | user application that composed a response. |
+------------------+--------------------------------------------------+
| Converter | The conversion program that performs conversion |
| | or other processing on the content of the |
| | request. |
+------------------+--------------------------------------------------+
| Userid | The userid which the alias transaction will be |
| | attached. |
+------------------+--------------------------------------------------+
| Program | The application program name that composes |
| | a response. |
+------------------+--------------------------------------------------+
| Pipeline | The name of the PIPELINE resource definition |
| | that provides information about the processing |
| | nodes that will act on the service request |
| | from the client. |
+------------------+--------------------------------------------------+
| WebService | The name of the Web service. |
+------------------+--------------------------------------------------+
| MediaType | The description of the data content of the |
| | static response. |
+------------------+--------------------------------------------------+
| CharacterSet | The name of the character set for the static |
| | response. |
+------------------+--------------------------------------------------+
| Codepage | The IBM codepage (EBCDIC) in which the text |
| | document that will form the static response |
| | is encoded. |
+------------------+--------------------------------------------------+
| HostName | The host component of the URL. |
+------------------+--------------------------------------------------+
| Pathname | The path component of the URL. |
+------------------+--------------------------------------------------+
| UME | The address of the URI Mapping Element |
| | control block. |
+------------------+--------------------------------------------------+
| UVH | The address of the URI Virtual Host |
| | control block. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CURSOR

CURSOR Command

The CURSOR command moves the cursor to the command line of


any display. The command also returns the cursor from the
command line to the place from which it was moved to the
command line.

To use the CURSOR command, define a PF key to execute the


command. For details on defining PF keys, see the SET or
PROFILE commands.

Once you have defined the PF key, press it to execute the


command.

Command Syntax

+---------------+------------------------------------------------------------+
| CURSOR | |
+---------------+------------------------------------------------------------+

Parameters

This command has no parameters.


CUSERS

CUSERS Command

The CUSERS command displays user information about currently


active users.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CUSERS | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Userid,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Userid | The external security userid identification. |
+------------------+--------------------------------------------------+
| Port | The port of entry. |
+------------------+--------------------------------------------------+
| Token | The token associated with the userid. |
+------------------+--------------------------------------------------+
| ACEE | The address of the external security ACEE. |
+------------------+--------------------------------------------------+
| XSDI | The address of the XSDI control block. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
CVLIST

CVLIST Command

The CVLIST command displays a list of product, user and OS defined


symbolic variables.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CVLIST | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Name,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Name | The name of the symbolic variable |
+------------------+--------------------------------------------------+
| Type | The symbolic variable type |
| | Possible values are: |
| | |
| | PROD Product-defined variable. |
| | USER User-defined variable |
| | OS System-defined variable (IEASYMnn). |
| | |
+------------------+--------------------------------------------------+
| Len | The length of the variable value. |
+------------------+--------------------------------------------------+
| Value | The value of the variable. |
+------------------+--------------------------------------------------+
| SeqNo | The variable definition sequence number. |
| | Variable definitions are kept on a push-down |
| | stack. The lowest sequence number is the last |
| | defined and first searched variable. The highest |
| | sequence number is the first defined and last |
| | searched variable. Duplicate names are possible |
| | and the first match is used. |
+------------------+--------------------------------------------------+

XSystem Data Fields


In xsystem data mode, additional data fields are present.
Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CWAITS

CWAITS Command

The CWAITS command displays a degradation analysis graph to


summarize the time spent by CICS on various execution and
wait reasons.

The information can be shown summarizing all transactions grouped


together, by transaction, or by defined transaction group.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CWAITS | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
| | [ TRAN = ] |
| | tran ] |
| | group ] |
| | |
| | [ TOTal | SYSInterval | INTerval ] |
| | |
| | [ Biz | NOBiz ] |
| | |
| | [ STATUS | NOSTATUS ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
| TRAN | Specify the transaction ID for which the |
| | degradation analysis is to be displayed. |
| | |
| | = - All transaction |
| | |
| | tran - specific transaction ID |
| | If mixed cases is needed, |
| | enter as: c'tran' |
| | |
| | group - transaction group |
| | |
+------------------+--------------------------------------------------+
| TOTal | Request analysis of data since data collection |
| | was last started. |
+------------------+--------------------------------------------------+
| SYSInterval | Request analysis of data for the current |
| | system interval. |
+------------------+--------------------------------------------------+
| INTerval | Request analysis of data for the current 60 |
| | second interval. |
+------------------+--------------------------------------------------+
| BIZ | Blank If Zero. |
| | Do not display a resource line if the associated |
| | value is zero. |
+------------------+--------------------------------------------------+
| NOBIZ | No Blank If Zero. |
| | Display all resources. |
+------------------+--------------------------------------------------+
| STATus | Evaluate the data field "Average' against |
| | threshold definitions. |
+------------------+--------------------------------------------------+
| NOSTATus | Do not evaluate the data field "Average" against |
| | threshold definitions. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Tran | Specified transaction ID or group |
+------------------+--------------------------------------------------+
| Transactions | The number of transactions that have been |
| | monitored for the specified interval. |
| | The count includes those transactions that |
| | were excluded from statistical averaging due |
| | to excessive life time values. |
+------------------+--------------------------------------------------+
| TranRate | Transaction rate per second for the specified |
| | interval. |
+------------------+--------------------------------------------------+
| Interval | The amount of time that has elapsed in the |
| | specified interval. |
+------------------+--------------------------------------------------+
| Exclude | The number of transactions that have been |
| | excluded from statistical averaging due to |
| | excessive life time values. |
+------------------+--------------------------------------------------+
| MaxLife | The maximum life time value of a transaction |
| | that will be included in statistical averaging. |
+------------------+--------------------------------------------------+
| JobCPU | CPU usage for the address space, expressed as a |
| | percentage. Average value for the last data |
| | collection interval. |
+------------------+--------------------------------------------------+
| Paging | Paging rate per second for the address space. |
| | Average value for the last data collection |
| | interval. |
+------------------+--------------------------------------------------+
| IORate | I/O rate per second for the address space. |
| | Average value for the last data collection |
| | interval. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname. |
+------------------+--------------------------------------------------+
| Resource | The resource name. The resource value is a |
| | description of the metric name in the field |
| | "Metric". |
| | |
| | Status for the following metrics will not be |
| | evaluated for long running transactions: |
| | |
| | LIFETIME |
| | |
+------------------+--------------------------------------------------+
| Average | The average time for each transaction monitored. |
| | This does not include those transactions that |
| | were excluded from statistical averaging due |
| | to excessive life time values. |
+------------------+--------------------------------------------------+
| Pct% | The percentage of lifetime spent in the |
| | corresponding activity. This information is |
| | also presented in graph form. |
| | |
| | If the metric is CPU related, the percentage |
| | is based on the total CPU time used by the |
| | transaction. |
+------------------+--------------------------------------------------+
| Total | The total time, in seconds, for all transactions |
| | monitored. |
| | This does not include those transactions that |
| | were excluded from statistical averaging due |
| | to excessive life time values. |
+------------------+--------------------------------------------------+
| Metric | The data collection metric/variable name. |
+------------------+--------------------------------------------------+
| DFHGroup | If the metric is related to a CICS transaction |
| MCTNum | performance data metric, the values displayed in |
| | DFHGroup and MCTNum fields will be the |
| | associated CICS performance data name as |
| | defined in the CICS Monitor Control Table. |
| | Additional information can be found in IBM's |
| | CICS Performance Guide. |
| | |
| | If the metric is not related to a CICS |
| | performance data metric, the DFHGroup field |
| | will display a "*" and the MCTNum field will be |
| | blank. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the CTRANDEG command to display |
| | transactions with a non-zero value for the |
| | selected metric. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| OPTions | Set and display command options. |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC |
| | variable. The variable created or updated is |
| | named SYSV_OPTIONS_CWAITS. EXTRACT is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. EXTRACT can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+------------------+--------------------------------------------------+

OPTIONS Subcommand

Use the OPTIONS subcommand to set and display CWAITS command display
and processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [options] |
+---------------+-----------------------------------------------------+

OPTIONS Parameter Values

The following table lists and explains the valid OPTIONS parameter
values. Any number of the values can be specified in any order.
The current settings of all options are always displayed in
response to the OPTIONS subcommand.

+------------------+--------------------------------------------------+
| Value | Explanation |
+------------------+--------------------------------------------------+
| TOTal | Request analysis of data since data collection |
| | was last started. |
+------------------+--------------------------------------------------+
| SYSInterval | Request analysis of data for the current |
| | system interval. |
+------------------+--------------------------------------------------+
| INTerval | Request analysis of data for the current 60 |
| | second interval. |
+------------------+--------------------------------------------------+
| BIZ | Blank If Zero. |
| | Do not display a resource line if the associated |
| | value is zero. |
+------------------+--------------------------------------------------+
| NOBIZ | No Blank If Zero. |
| | Display all resources. |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC |
| | variable. The variable created or updated is |
| | named SYSV_OPTIONS_CWAITS. |
| | |
| | EXTRACT is only valid when the product is |
| | running under a TSO CLIST or REXX exec. |
| | EXTRACT can be specified alone or in combination |
| | with any other OPTIONS keywords. |
+------------------+--------------------------------------------------+

Notes
CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CWEBSERV

CWEBSERV Command

The CWEBSERV command displays the current status and configuration


of CICS Web services. A CICS WEBSERVICE definition defines the
run time attributes or properties for a CICS application program
deployed in a Web services environment.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CWEBSERV | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Name,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Name | Specifies the name of the web service. |
+------------------+--------------------------------------------------+
| Status | Specifies . |
| | Possible values are: |
| | DISCARDING |
| | INITING |
| | INSERVICE |
| | UNUSABLE |
+------------------+--------------------------------------------------+
| Count | Current usage count |
+------------------+--------------------------------------------------+
| Total | Total usage count |
+------------------+--------------------------------------------------+
| Program | Program name |
+------------------+--------------------------------------------------+
| Pipeline | Defines the set of message application |
| | handlers that act on Web service requests and |
| | responses. |
+------------------+--------------------------------------------------+
| WSBCTL | Specifies the address of the WSBCTL |
| | control block. |
+------------------+--------------------------------------------------+
| WSBind | The Web service binding file contains |
| | information that is used at run time to |
| | provide the mapping between application data |
| | structures and SOAP messages. |
+------------------+--------------------------------------------------+
| WSDL | The Web service description file on HFS. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CWLMHLTH

CWLMHLTH Command

The CWLMHLTH command displays the z/OS WLM health indicators of CICS.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CWLMHLTH | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Status | The WLM health status |
| | Possible values are: |
| | |
| | OFF - Inactive |
| | |
| | OPENING - CICS is increasing the |
| | WLM Health indicator. The |
| | health indicator value is in the |
| | range 0 to 99. |
| | |
| | OPEN - CICS has completed increasing |
| | the WLM Health indicator to |
| | a value of 100. |
| | |
| | CLOSING - CICS is decreasing the WLM |
| | Health indicator to a value |
| | of 0. |
| | |
| | CLOSED - CICS has completed decreasing |
| | the WLM Health indicator to |
| | a value of 0. |
| | |
| | IMMCLOSING - CICS is immediately setting |
| | the WLM Health indicator to |
| | a value of 0. |
| | |
+------------------+--------------------------------------------------+
| Health | The current z/OS WLM Health indicator for the |
| | CICS region. |
| | The value will be in the range 0 to 100. |
+------------------+--------------------------------------------------+
| Adjust | The adjustment value that adjusts the z/OS |
| | WLM health indicator of the CICS region at each |
| | interval. |
+------------------+--------------------------------------------------+
| Interval | The WLM health interval between calls that |
| | CICS makes to the z/OS WLM Health API. |
| | The value must be in the range 0 to 60 seconds. |
+------------------+--------------------------------------------------+
| Reason | The WLM health set reason. |
+------------------+--------------------------------------------------+
| SetDate | The last date and time the health indicator |
| SetTIme | was reported to z/OS WLM. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
CXDISTAT

CXDISTAT Command

The CXDISTAT display provides information about the CICS external


data interface requests.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| | |
| CXDISTAT | [ REGion | SYStem ] |
| | [ GROUP group ] |
| | |
| | [ XSYSTEM | NOXSYSTEM ] |
| | [ XSGROUP group ] |
| | |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Sets the display mode to show only the current |
| LOCAL | target address space. |
| | |
| | This forces system and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| SYStem | Sets the display mode to show all CICS address |
| GLOBAL | spaces being monitored on the current system. |
| | |
| | This forces region and cross-system data |
| | collection to be set off for this execution. |
| | The current profile settings for CICSMODE and |
| | XSDATA are maintained. |
| | |
| | If this parameter is not specified then the |
| | CICSMODE and CICSGROUP profile settings |
| | determine the display mode. |
+------------------+--------------------------------------------------+
| XSYStem | Sets the display mode to show all CICS address |
| XSData | spaces being monitored for all systems. |
| | |
| | This forces region and system data collection |
| | to be set off for this execution. The current |
| | profile setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | Forces cross-system data collection to be set |
| NOXSData | off for this execution. The current profile |
| | setting of XSDATA is maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies a value that determines the CICS |
| | jobnames to be displayed. |
| | |
| | If this parameter is not specified then the |
| | CICSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type CICSPLEX |
| | that contains a list of CICS jobnames.|
| | The list of CICSPLEX groups can be |
| | found on the GROUPS command. |
| | |
| | * - No group processing is required. |
| | All CICS regions will be displayed. |
| | This can be used to bypass the |
| | CICSGROUP profile setting. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| CICS | The CICS version of the current jobname if it is |
| | monitored by the CICS data collector. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | The current CICSPLEX group name specified by the |
| | GROUP parameter. This field is only displayed |
| | when a group has been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,Jobname,A,Code,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The CICS jobname |
+------------------+--------------------------------------------------+
| Code | Function code |
+------------------+--------------------------------------------------+
| Function | Function name |
+------------------+--------------------------------------------------+
| Requests | The number of times the function has been |
| | requested. |
+------------------+--------------------------------------------------+
| ACPUTime | The average CPU time used by the function |
| | on a single request. |
+------------------+--------------------------------------------------+
| AElapsed | The average elapsed time for the function |
| | on a single request. |
+------------------+--------------------------------------------------+
| TCPUTime | The total CPU time used by the function. |
+------------------+--------------------------------------------------+
| TElapsed | The total elapsed time for the function. |
+------------------+--------------------------------------------------+
| EnclTime | The total enclave CPU time. |
+------------------+--------------------------------------------------+
| ePct% | The percent of the total CPU time used by the |
| | task that executed on an enclave. |
| | |
| | ePct% = EnclTime * 100 |
| | --------------------- |
| | TCPUTime |
| | |
+------------------+--------------------------------------------------+
| zIIPTime | The total enclave CPU time running on a |
| | zIIP processor. |
+------------------+--------------------------------------------------+
| zPct% | The percent of the total CPU time used by the |
| | task that executed on a zIIP processor. |
| | |
| | zPct% = zIIPTime * 100 |
| | --------------------- |
| | TCPUTime |
| | |
+------------------+--------------------------------------------------+
| zIIPonCP | The total enclave CPU time that ran on a |
| | general processor that was eligible to run on a |
| | zIIP processor. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

CICS automatic address space switch

This command performs an automatic address space switch to the


jobname set by the SET CICSTGTDEF option.

If the current target address space is a monitored CICS region,


no auto switch is performed.

If the command is executed in SYSTEM mode or XSYSTEM mode, when


supported, no auto switch is performed.
DASD

DASD Command

The DASD command displays the status of DASD devices in the system.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+---------------+------------------------------------------------------------+
| DASD | [volser][,status][,devn][,unit][,usage][,storgrp][,model] |
+---------------+------------------------------------------------------------+

Parameters

All parameters are optional.

+---------+----------+---------+---------+------------+-----------+----------+
| Use one | Use one | Use one | Use one | Use one | Use one | Use one |
| volser | status | devn | unit | usage | storgrp | model |
+---------+----------+---------+---------+------------+-----------+----------+
| = | ALL | = | = | ALL | = | = |
| volser | ALLOc | hex | unit | PRivate | storgrp | model |
| | Busy | | | PUblic | | |
| | OFfline | | | Storage | | |
| | ONline | | | | | |
+---------+----------+---------+---------+------------+-----------+----------+

Volser Parameter Values Explained

+----------------+-----------------------------------------------------------+
| Volser Value | Explanation |
+----------------+-----------------------------------------------------------+
| = | An equal sign entered as the volser lists all volsers. |
| | = is the default. |
+----------------+-----------------------------------------------------------+
| volser | The volume serial number, if applicable. Masking |
| | characters (* and =) can be used when entering a partial |
| | volser. |
+----------------+-----------------------------------------------------------+

Status Parameter Values Explained

+----------------+-----------------------------------------------------------+
| Status Value | Explanation |
+----------------+-----------------------------------------------------------+
| ALL | All status values. ALL is the default. |
+----------------+-----------------------------------------------------------+
| ALLOc | All allocated devices. |
+----------------+-----------------------------------------------------------+
| Busy | All busy devices. |
+----------------+-----------------------------------------------------------+
| OFfline | All offline devices. |
+----------------+-----------------------------------------------------------+
| ONline | All online, allocated, or busy devices. |
+----------------+-----------------------------------------------------------+

Devn Parameter Values Explained

+----------------+-----------------------------------------------------------+
| Devn Value | Explanation |
+----------------+-----------------------------------------------------------+
| = | Lists all device numbers. = is the default. |
+----------------+-----------------------------------------------------------+
| devn | The device number. Masking characters (* or =) can be |
| | used to enter a partial device number. |
+----------------+-----------------------------------------------------------+

Unit Parameter Values Explained

+---------------+------------------------------------------------------------+
| Unit Value | Explanation |
+---------------+------------------------------------------------------------+
| = | Lists all units. = is the default. |
+---------------+------------------------------------------------------------+
| unit | The name of the unit. Masking characters (* and =) can be |
| | used to enter a partial unit name. The unit name can be |
| | generic or esoteric. |
+---------------+------------------------------------------------------------+

Usage Parameter Values Explained

+----------------+-----------------------------------------------------------+
| Usage Value | Explanation |
+----------------+-----------------------------------------------------------+
| ALL | All mounted volumes. ALL is the default. |
+----------------+-----------------------------------------------------------+
| PRivate | Specifies that the volume is mounted private. |
+----------------+-----------------------------------------------------------+
| PUblic | Specifies that the volume is mounted public. |
+----------------+-----------------------------------------------------------+
| Storage | Specifies that the volume is mounted storage. |
+----------------+-----------------------------------------------------------+

Storgrp Parameter Values Explained

+---------------+------------------------------------------------------------+
| Storgrp Value | Explanation |
+---------------+------------------------------------------------------------+
| = | Lists all SMS storage groups. = is the default. |
+---------------+------------------------------------------------------------+
| storgrp | The name of the storage group. Masking characters |
| | (* and =) may be used to enter a partial storage group |
| | name. |
+---------------+------------------------------------------------------------+

Model Parameter Values Explained

+---------------+------------------------------------------------------------+
| Unit Value | Explanation |
+---------------+------------------------------------------------------------+
| = | Lists all models. = is the default. |
+---------------+------------------------------------------------------------+
| model | The name of the specific model for the unit. |
| | Masking characters can be used. |
+---------------+------------------------------------------------------------+

Information Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Interval | The interval, in seconds, used for the rate monitoring |
| | calculations. The time between two successive screen |
| | refreshes or two seconds, whichever is larger, is used. |
| | When XSDATA is YES this value is displayed in |
| | the data rows as field "Intvl". |
+---------------+------------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Volser | The volume serial number. An online unit with no volume |
| | mounted allows input in this field. This field must be |
| | specified when issuing the MNT command in the command |
| | input field. If this field is overtyped and MNT is not in |
| | the command input field, then the new value is ignored. |
+---------------+------------------------------------------------------------+
| Devn | The device number. |
+---------------+------------------------------------------------------------+
| Status | The status of a device. Valid values are: |
| | |
| | ALLOC Allocated device |
| | ALLOC-P Allocated device with VARY OFFLINE pending |
| | ALLOC-X Device allocated to some external system |
| | This is only possible for autoswitchable |
| | tape devices |
| | BUSY Busy device |
| | BUSY--P Busy device with VARY OFFLINE pending |
| | OFFLINE Offline device |
| | ONLINE Online but unallocated device |
| | ONLIN-P Online with VARY OFFLINE pending |
+---------------+------------------------------------------------------------+
| Model | The unit model name. |
| | |
| | The unit type 3390-9 can have multiple models that are |
| | based on the capacity or number of cylinders on the |
| | volume. |
| | |
| | Possible values are: |
| | |
| | Model Cylinders |
| | -------- --------- |
| | 3390-1 1113 |
| | 3390-2 2226 |
| | 3390-3 3339 |
| | 3390-9 10017 |
| | 3390-27 32760 |
| | 3390-54 65520 |
| | 3390-A other |
| | |
| | If the unit name is not "3390-9" then the model |
| | name will be the same as the unit name. |
| | |
+---------------+------------------------------------------------------------+
| Cyls | The number of cylinders configured on the device. |
| | |
| | The number of cylinders is obtained from the UCB DCE |
| | (Device Class Extension). This may differ from the |
| | number of cylinders shown on the SPACE command. |
| | The SPACE command obtains the number of cylinders |
| | from the VTOC format-4 DSCB. |
+---------------+------------------------------------------------------------+
| Usage | Volume usage information. To use the MNT line command to |
| | mount a new volume or change the usage attribute of a |
| | currently mounted value, you can overtype this field with |
| | the value PRIVATE, PUBLIC, or STORAGE. If you are |
| | mounting a new volume and do not specify a usage, then the |
| | default of PRIVATE is assumed. |
| | |
| | Values that can appear in the Usage field are: |
| | |
| | PRIVATE Volume is mounted private |
| | PUBLIC Volume is mounted public |
| | STORAGE Volume is mounted storage |
| | xxxxx-S Indicates a system residence volume |
| | xxxxx-P Indicates a paging volume |
| | xxxx-SP Indicates both system residence and |
| | paging volume |
+---------------+------------------------------------------------------------+
| Shr | Specifies whether a DASD volume is marked as shared |
| | between systems. |
+---------------+------------------------------------------------------------+
| SMS | SMS in this field indicates that the volser is part of a |
| | SMS storage group as indicated in the UCB. Otherwise it |
| | is blank. |
+---------------+------------------------------------------------------------+
| Stor-Grp | The SMS storage group name to which the volser belongs. |
+---------------+------------------------------------------------------------+
| IORt | The I/O rate (SSCH instructions per second). |
+---------------+------------------------------------------------------------+
| IOCt | The I/O count (SSCH instructions). |
+---------------+------------------------------------------------------------+
| ASID | The address space ID of the last job to allocate the unit. |
+---------------+------------------------------------------------------------+
| Jobname | The name of the last job to allocate the unit. |
+---------------+------------------------------------------------------------+
| UseCt | The UCB use count. |
+---------------+------------------------------------------------------------+
| SSid | The cache control unit storage subsystem identifier. |
+---------------+------------------------------------------------------------+
| Schn | The subchannel number. |
+---------------+------------------------------------------------------------+
| Dyn | Specifies DYN for a dynamic UCB. Otherwise, it is blank. |
+---------------+------------------------------------------------------------+
| Ctl-Unit | The control unit model number. |
+---------------+------------------------------------------------------------+
| Gen-Unit | The gen'd unit name. |
+---------------+------------------------------------------------------------+
| Unit | The unit name. |
| | |
| | If the unit name equals "3390-9", see the following |
| | fields for specific model information: |
| | |
| | Model |
| | Cyls |
| | |
+---------------+------------------------------------------------------------+
| EAV | This field contains EAV for an Extended Addressing Volume |
| | (a volume configured with more than 65,520 cylinders). |
+---------------+------------------------------------------------------------+
| Pav | Specifies PAV for a parallel access volume. |
+---------------+------------------------------------------------------------+
| PavCt | The current number of PAV devices associated with this |
| | device. |
+---------------+------------------------------------------------------------+
| HPav | HPAV for a hyper parallel access volume. |
+---------------+------------------------------------------------------------+
| HPavCt | The current number of HyperPAV alias devices configured |
| | in the LSS pool. |
+---------------+------------------------------------------------------------+
| WLM | WLM for a parallel access volume that is managed by WLM. |
+---------------+------------------------------------------------------------+
| AM | Specifies AM if activity monitoring is active. Otherwise, |
| | it is blank. |
+---------------+------------------------------------------------------------+
| IOStatus | The status of the I/O for the device. Valid values are: |
| | |
| | SUSPEND Subchannel has been suspended |
| | RESERVE Device has been reserved |
| | RESERVE-P Device reserve pending |
| | RELEAS-P Device release pending |
| | INTVREQD Intervention required |
| | NOTREADY Device not ready |
| | BOXED Device is boxed |
| | MOUNT-P Mount is pending |
| | UNLOAD-P Unload is pending |
+---------------+------------------------------------------------------------+
| IOType | The type of I/O operation if the device is busy. Valid |
| | values are START, HALT, or CLEAR. |
+---------------+------------------------------------------------------------+
| IODriver | The name of the I/O driver if the device is busy. |
+---------------+------------------------------------------------------------+
| SeekAddr | The seek address for the currently active I/O. |
+---------------+------------------------------------------------------------+
| Dataset-Name | The data set name to which SeekAddr is allocated if |
| | activity monitoring is active and SeekAddr is not blank. |
| | Otherwise, it is blank. |
+---------------+------------------------------------------------------------+
| UCB | The UCB address. |
+---------------+------------------------------------------------------------+
| UCBCMEXT | The UCB common extension address. |
+---------------+------------------------------------------------------------+
| UCBCLEXT | The UCB device class extension address. |
+---------------+------------------------------------------------------------+
| UCBIEXT | The UCB IOS extension (prefix) address. |
+---------------+------------------------------------------------------------+
| Intvl | The interval, in seconds, used for the rate monitoring |
| | calculations. The time between two successive screen |
| | refreshes or two seconds, whichever is larger, is used. |
| | When XSDATA is NO this value is displayed in |
| | the information section as "Interval" |
+---------------+------------------------------------------------------------+
XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Mount | Issues the MVS MOUNT command for the selected Devn and |
| Mnt | specified Volser and Usage fields. This command mounts |
| | only standard label (SL) volumes. If no volume is |
| | currently mounted, then the Volser and Usage fields must |
| | be entered. If a DASD volume is mounted, then its usage |
| | attribute can be changed by overtyping the Usage field. |
| | See the Volser and Usage field descriptions above. |
+---------------+------------------------------------------------------------+
| OFf | Issues the MVS VARY OFFLINE command for the selected Devn |
| | field. |
+---------------+------------------------------------------------------------+
| ON | Issues the MVS VARY ONLINE command for the selected Devn |
| | field. |
+---------------+------------------------------------------------------------+
| PAM | Stop activity monitoring. |
| PM | |
+---------------+------------------------------------------------------------+
| SAM | Start activity monitoring. Activity monitoring attempts |
| SM | to use the SeekAddr for any active I/O to determine the |
| | name of the data set for which the I/O is active. The |
| | VTOC is read into storage and retained until activity |
| | monitoring is stopped. To refresh the instorage VTOC, use |
| | the RAM command described below. This command is only |
| | valid for online volumes. |
+---------------+------------------------------------------------------------+
| RAm | Refresh activity monitoring. Rereads the VTOC to refresh |
| RM | the instorage copy of the VTOC. |
+---------------+------------------------------------------------------------+
| Unload | Issues the MVS UNLOAD command for the selected Devn field. |
+---------------+------------------------------------------------------------+
| VALpath | Invokes the VALPATH command for the selected device. |
| VALidate | |
| VLD | |
+---------------+------------------------------------------------------------+
| Zap | Invokes the ZAP command for the volser. |
+---------------+------------------------------------------------------------+
| ZRO | Invokes the ZAP command with the READONLY option. |
+---------------+------------------------------------------------------------+
| ZRW | Invokes the ZAP command with the READWRITE option. |
+---------------+------------------------------------------------------------+

Navigation Line Commands


+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Allocas | Invokes the ALLOCAS command for the selected Devn field. |
+---------------+------------------------------------------------------------+
| CCtl | Invoke the CACHECTL command for the selected ssid. |
+---------------+------------------------------------------------------------+
| CDev | Invoke the CACHEDEV command for the selected volser. |
+---------------+------------------------------------------------------------+
| CONnect | Plot the device connect time for the selected volser. |
+---------------+------------------------------------------------------------+
| DISconn | Plot the device disconnect time for the selected volser. |
+---------------+------------------------------------------------------------+
| DSinfo | Invokes the DSINFO VTOC command to display information |
| Info | about the DASD volume. |
+---------------+------------------------------------------------------------+
| EXtents | Invokes the EXTENTS command for the selected Volser field. |
| Xtents | |
| Xtns | |
+---------------+------------------------------------------------------------+
| EDT | Invoke the EDT command for the selected volser. |
+---------------+------------------------------------------------------------+
| IO | Plot the SSCH instruction count for the selected volser. |
| USE | |
+---------------+------------------------------------------------------------+
| IOCdata | Invokes the IOCDATA command for the selected device. |
+---------------+------------------------------------------------------------+
| OUtput | Invokes the OUTPUT command to display the output of |
| | the job that last allocated the unit. |
+---------------+------------------------------------------------------------+
| Path | Invokes the DEVPATH command for the selected device. |
| Pth | |
+---------------+------------------------------------------------------------+
| PENding | Plot the device pending time for the selected volser. |
+---------------+------------------------------------------------------------+
| PLot | Invokes a PLOTLIST DEVICE command to display a plot |
| PLt | selection list for the selected volser. |
+---------------+------------------------------------------------------------+
| SERvice | Plot the device service time for the selected volser. |
+---------------+------------------------------------------------------------+
| Space | Invokes the SPACE command for the selected Volser field. |
| Spc | |
+---------------+------------------------------------------------------------+
| SUbchan | Invokes the SUBCHAN command for the selected device. |
| SChn | |
+---------------+------------------------------------------------------------+
| VCc | Invokes the VTOC command for the volser with the CHKCAT |
| | keyword. |
+---------------+------------------------------------------------------------+
| VMap | Invokes the VOLMAP command for the selected volser. |
| MAp | |
+---------------+------------------------------------------------------------+
| Vtoc | Invokes the VTOC command for the selected Volser field. |
| Vtc | |
+---------------+------------------------------------------------------------+
| XCc | Invokes the EXTENTS command for the volser with the CHKCAT |
| | keyword. |
+---------------+------------------------------------------------------------+

Subcommands
+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. |
+---------------+------------------------------------------------------------+

Messages

DASD001E [linecmd] line command invalid, unit [devname] has no logical paths

The line command [linecmd] is invalid because no logical paths


exist to device [devname].

DASD002E [linecmd] line command invalid, volser [volser] permanently resident

The line command [linecmd] is invalid because the volume [volser]


is permanently resident.

DASD003E [linecmd] line command is invalid for status [status]

The line command [linecmd] is invalid when the unit has a status
of [status].

DASD004E [linecmd] line command invalid for type [type]

The line command [linecmd] is invalid for the device type [type].
Make sure that you want to perform the line command [linecmd]
against the device type [type].

DASD005E [linecmd] line command invalid, no volume mounted

The line command [linecmd] is invalid when no volume is mounted.

DASD006E Volser required for [linecmd] line command

The line command [linecmd] lacks a volume serial number. Specify


a volume serial number and issue the line command again.

DASD007E Invalid volser

The volume serial number is invalid because it contains embedded


blanks. Remove the embedded blanks and issue the command again.

DASD008E Usage keyword required for [linecmd] line command

A usage parameter is required with the line command [linecmd].


Enter a usage parameter with the line command.

DASD009E Invalid usage keyword

The highlighted usage keyword is invalid. Valid keywords are


PRIVATE, PUBLIC, and STORAGE. Change the usage parameter and
issue the command again.

DASD010E SAM invalid, activity monitor already started for volser [volser]

The SAM line command (Start Activity Monitor) was issued for a volser
where it had already been started.

DASD011E SAM invalid, activity monitor table is full


The SAM line command (Start Activity Monitor) could not be completed
because the activity monitor table is full. You must use the PAM line
command (stoP Activity Monitor) on some other volser where it is
active before the SAM line command can be issued for a new volume.

DASD012E [PAM|RAM] invalid, activity monitor not started for volser [volser]

The PAM (stoP Actvity Monitor) or RAM (Refresh Activity Monitor) line
command was issued for a volser where it had never been started.

DASD013E [linecmd] invalid, volume [vlsr] is not on a caching subsystem

Informational only.

DASD014E [linecmd] line command invalid, no jobname available

Informational only.
DASDRESP

DASDRESP Command

The DASDRESP command displays response time information that


has been collected by the MVS Data Collector. Status is
indicated based on exception checking performed during the
last threshold interval. Alert status is only displayed if
the CURRENT interval is requested.

The data for this command requires the following to be active:

* MVS Data Collector - Task name MVSDATA


* Scheduled Event function - MVSDATA-DEVICES

Command Syntax

+---------------+-----------------------------------------------------+
| DASDREsp | [ Current | Average | Minimum | Maximum ] |
| | [ Normal | Warning ] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| Current | The average values over the last 2 minutes. |
+------------------+--------------------------------------------------+
| Average | The average value over the last hour. |
+------------------+--------------------------------------------------+
| MInimum | The minimum value over the last hour. |
+------------------+--------------------------------------------------+
| MAximum | The maximum value over the last hour. |
+------------------+--------------------------------------------------+
| Normal | Specifies all entries. |
+------------------+--------------------------------------------------+
| Warning | Specifies only those entries that have a |
| | combined status greater than Normal. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Volser | The volume serial number. |
+------------------+--------------------------------------------------+
| Devn | The device number. |
+------------------+--------------------------------------------------+
| Service | The total device service time. |
| | |
| | service = connect + disconnect + pend + queue |
+------------------+--------------------------------------------------+
| Connect | The device connect time. |
| | |
| | The average time the device was connected to a |
| | channel path and actually transferring data |
| | between the device and central storage. |
+------------------+--------------------------------------------------+
| Disconn | The subchannel disconnect time. |
| | |
| | The average time the device was disconnected |
| | (not transferring data) while processing an |
| | SSCH instruction. |
+------------------+--------------------------------------------------+
| Pend | The SSCH request pending time. |
| | |
| | The average time an I/O request remains queued |
| | in the channel. |
+------------------+--------------------------------------------------+
| Queue | The control unit queue time. |
| | |
| | The average time an I/O request must wait on |
| | an IOS queue before a SSCH instruction can be |
| | issued. |
+------------------+--------------------------------------------------+
| Active | The device active time. |
| | |
+------------------+--------------------------------------------------+
| CmdResp | The device initial command response time. |
| | |
| | The average delay time that a successfully |
| | initiated start or resume function needs |
| | until the first command is indicated as |
| | being accepted by the device. |
+------------------+--------------------------------------------------+
| DBusy | The device busy or delay time. |
| | |
| | The average delay time that I/O requests to |
| | this device encountered because the device |
| | was busy. |
+------------------+--------------------------------------------------+
| Busy% | The device busy percentage. |
| | |
| | (total connect + total disconnect) |
| | ---------------------------------- * 100 |
| | interval |
+------------------+--------------------------------------------------+
| SSCHRate | The SSCH instruction rate. |
+------------------+--------------------------------------------------+
| SSCHSamp | The SSCH sample count. |
+------------------+--------------------------------------------------+
| SSCHCnt | The SSCH instruction count. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Select | Invoke the DASD command for the selected volser. |
| Dasd | |
+----------+----------------------------------------------------------+
| CONnect | Invoke the PLOT command to plot the device connect time. |
+----------+----------------------------------------------------------+
| DISconn | Invoke the PLOT command to plot the device disconnect |
| | time. |
+----------+----------------------------------------------------------+
| IO | Invoke the PLOT command to plot the device SSCH |
| USE | instruction count. |
+----------+----------------------------------------------------------+
| PENding | Invoke the PLOT command to plot the metric device |
| | pending time. |
+----------+----------------------------------------------------------+
| PLot | Invoke the PLOTLIST command to display a list of |
| | predefined plot lists. |
+----------+----------------------------------------------------------+
| SERvice | Invoke the PLOT command to plot the device service time. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+
DAT

DAT Command

The DAT command controls the dynamic address translation (DAT)


mode of the DISASSEM, DUMP, MAP, and SNAP commands. When DAT
mode is ON, virtual storage is displayed. When DAT mode is OFF,
real storage is displayed.

Command Syntax

+---------------+------------------------------------------------------------+
| DAT | [toggle] |
+---------------+------------------------------------------------------------+

Parameters

+------------------------------------------------------------+
| Use one toggle (Optional) |
+------------------------------------------------------------+
| ON |
| OFf |
+------------------------------------------------------------+

Toggle Parameter Values Explained

+---------------+------------------------------------------------------------+
| Value | Explanation |
+---------------+------------------------------------------------------------+
| ON | Sets dynamic address translation mode to ON. ON is the |
| | default value. |
+---------------+------------------------------------------------------------+
| OFf | Sets dynamic address translation mode to OFF. |
+---------------+------------------------------------------------------------+
DATACOM

DATACOM Command

The DATACOM command changes the current target Datacom address


space.

The current target address space is referenced by any command that


displays information for a particular Datacom address space.

When using the "First, Last, Next and Prev" parameters, the selected
new address space is based on the sorted list of Datacom jobnames.

Command Syntax

+------------------+--------------------------------------------------+
| DATACOM | [jobname] |
| | [ First | Last | Next | Prev ] |
| | [CLOSE] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| jobname | The Datacom jobname. |
| | See the DCLIST command display for a list of |
| | active Datacom jobs. |
+------------------+--------------------------------------------------+
| First | The first active Datacom jobname. This is the |
| | default. |
+------------------+--------------------------------------------------+
| Last | The last active Datacom jobname. |
+------------------+--------------------------------------------------+
| Next | The next active Datacom from the current |
| | jobname. |
+------------------+--------------------------------------------------+
| Prev | The previous active Datacom from the current |
| | jobname. |
+------------------+--------------------------------------------------+
| CLOSE | Close the current Datacom connection. |
+------------------+--------------------------------------------------+

Messages

DCOM001W Job [jobname] is not defined as a Datacom address space

The requested jobname has not been defined as a Datacom


monitored address space in the parameter library member
DATACOM.

DCOM002E Datacom data not available, required license authorization failed.

Your system is not licensed to run the Datacom component.


DCOM003I ASID switched to Datacom job [jobname] ASID [asid] release [release]

The ASID is successfully switched to the job [jobname] and


ASID [asid]. The Datacom release is [release].

DCOM004W No active Datacom address spaces found

None of the Datacom address spaces defined in the DATACOM


parmlib member are active.

DCOM005E Job [jobname] not found

The requested Datacom address space could not be found.

DCOM006E [req] request failed, RC [rc], RS [rs], FC [fc], Job [jobname]

The Datacom request [req] failed. The request was


performed on job name [jobname]. Note the return code [rc],
reason code [rs] and function code [fc] and contact
technical support. The return code and reason code can be
looked up in the Datacom/DB message reference guide. The
function code is SYSVIEW specific.

Common return and reason codes:

RC=87 RS=40

Description: The execution of your program was


aborted during the process of
opening a User Requirements Table
because it did not meet the criteria
established by site management for
accessing or updating the database.

Action: Consult Datacom administrator and determine


if a User open exit is in place (DBUSROPA or
DBUSROPB). If so, update the user exit to
allow access for this userid and/or jobname.

DCOM007E Storage request failed. RC=[rc]

A request for storage failed. The return code is displayed


as [rc].

DCOM009E [dbid] is not a valid DBID

An invalid Database ID has been specified.


Valid DBIDs are *, =, ALL, and 1 - 5000.

DCOM010E Datacom processing abended

A Datacom module abended. Use the LISTLOG command to obtain


more messages about the abend.

DCOM011W Datacom SVC is not at a high enough release

The command requested could not be performed because the


Datacom SVC used by the selected Datacom job was not at
a high enough release.

DCOM012W [command] command not supported for Datacom [release]


The command entered is not available for the Datacom MUF at
the specified release.

DCOM013E ISGQUERY service failed RC [RetCode] RSN [RsnCode]

Refer to ISGQUERY documentation to interpret return and


reason codes.

DCOM014E Datacom release [release] job [jobname] is not supported

Access to Datacom [release] is not possible with this release of


SYSVIEW. An older release of SYSVIEW is required to access this
older release of Datacom.
DATE

DATE Command

The DATE command displays the current date and time in a message.

Command Syntax

+---------------+------------------------------------------------------------+
| DATE | |
+---------------+------------------------------------------------------------+

The DATE command has no parameters.

Messages

DATE001I The date is [cdate] and the time is [ctime]

This message displays the current date and time in response to a


DATE command.
DBBPOOLS

DBBPOOLS Command

The DBBPOOLS command displays information about DB2 buffer pools.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DBBPools | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | |
| | [ INTerval | TOTal ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | If the command supports cross system data |
| | collection, this parameter forces cross system |
| | data collection to be off for this execution, |
| | but the current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Db2 subsystems |
| | on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of Db2 subsystems to be displayed. The list of |
| | available groups with type DB2SSID can be found |
| | on the GROUPS command. A group name of "*" can |
| | be entered to indicate that no group processing |
| | is required. |
+------------------+--------------------------------------------------+
| INTerval | Displays interval data, which is the difference |
| | between the most current interval and the |
| | previously collected data. |
+------------------+--------------------------------------------------+
| TOTal | Displays data representing total statistical |
| | accumulation since DB2 was started. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| DB2 | The Db2 version if the current address space is |
| | a Db2 address space. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem identifier if the current |
| | address space is a Db2 address space. |
+------------------+--------------------------------------------------+
| Mode | Specifies the current mode. |
| | Possible value are: |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
+------------------+--------------------------------------------------+
| Group | Current DB2SSID group name specified by the |
| | GROUP command parameter. |
| | This entry is displayed only when a group has |
| | been specified. |
+------------------+--------------------------------------------------+
| Interval | Specifies the data collection mode. |
| | Possible value are: |
| | [###] - When the INTerval parm is specified |
| | or the default is used, this value |
| | is the data collection interval |
| | duration. |
| | DELTA - When the INTerval parm is specified |
| | or the default is used, but the |
| | interval start and end are not |
| | available. |
| | TOTAL - The TOTAL parameter was specified |
| | and the numbers displayed are |
| | totals since DB2 was started. |
+------------------+--------------------------------------------------+
| Start | Indicates the start time for the interval. |
| | This label is only displayed when interval data |
| | data collection is being displayed. |
+------------------+--------------------------------------------------+
| End | Indicates the end time for the interval. |
| | This label is only displayed when interval data |
| | data collection is being displayed. |
+------------------+--------------------------------------------------+

Data Fields
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SSID | The DB2 subsystem ID. |
+------------------+--------------------------------------------------+
| Pool | The name of the buffer pool. |
+------------------+--------------------------------------------------+
| Status | The status of the buffer pool. Valid values are: |
| | |
| | ALLOC The buffer pool is allocated |
| | DEALLOC The buffer pool is deallocated |
+------------------+--------------------------------------------------+
| Size | Size of the virtual buffer pool. |
+------------------+--------------------------------------------------+
| Alloc | The number of buffers allocated for a virtual |
| | buffer pool. |
+------------------+--------------------------------------------------+
| Current | The amount of active (in use or updated) pages |
| | in the buffer pool. |
+------------------+--------------------------------------------------+
| Curr% | The percentage of active (in use or updated) |
| | pages in the buffer pool. |
+------------------+--------------------------------------------------+
| Warn | The total of all exceptions for the buffer pool. |
+------------------+--------------------------------------------------+
| GetPages | The number of buffer pool GETPAGE requests. This |
| | includes all unconditional and successful |
| | conditional requests. |
+------------------+--------------------------------------------------+
| SyncRdIo | The number of synchronous physical I/O operations|
| | that have occurred to read pages of data from |
| | DB2 tables. |
+------------------+--------------------------------------------------+
| ReadEff | The ration of GETPAGE requests to Synchronous |
| | I/O operations. |
+------------------+--------------------------------------------------+
| SeqStl% | The virtual pool sequential steal threshold of |
| | the buffer pool. |
+------------------+--------------------------------------------------+
| BuffUpd | The number of records that were updated in the |
| | buffer pool. |
+------------------+--------------------------------------------------+
| BufUpEff | The average number of updates to a buffer pool |
| | page before writing the page to DASD. A high |
| | ratio implies that DB2 should be performing |
| | fewer write I/O operations because fewer pages |
| | are being updated. |
+------------------+--------------------------------------------------+
| PgWrites | The number of updated buffer pool pages that |
| | have been written to DASD. |
+------------------+--------------------------------------------------+
| WriteIo | Displays the total number of syncrhonous and |
| | and asynchronous I/O operations performed. |
+------------------+--------------------------------------------------+
| SzChange | The number of successful buffer pool expansions |
| | or contractions because of the alter bufferpool |
| | command. |
+------------------+--------------------------------------------------+
| PgFix | Indicates whether a page is fixed in real |
| | storage when it is first used. Valid values are: |
| | |
| | PGFIX Page is fixed when it is first used |
| | blank Page is not fixed when it is first |
| | used |
+------------------+--------------------------------------------------+
| PgStl | Specifies the page stealing algorithm to be used |
| | for the buffer pool. Valid values are: |
| | |
| | LRU Least recently used is to be used |
| | FIFO First in first out is to be used |
+------------------+--------------------------------------------------+
| Auto | Indicates whether automatic buffer pool size |
| | management is enabled. Valid values are: |
| | |
| | AUTO Automatic buffer pool size management |
| | is enabled |
| | blank Automatic buffer pool size management |
| | is not enabled |
+------------------+--------------------------------------------------+
| OpenDS | Specifies the current number of database data |
| | sets open in the buffer pool. |
+------------------+--------------------------------------------------+
| DataMgmt | Indicates the number of times the buffer pool |
| | has had at least 95 percent of the buffers |
| | unavailable and DB2 was forced to perform write |
| | I/O operations synchronously. |
+------------------+--------------------------------------------------+
| SeqPrfDis | Displays the number of times that DB2 failed to |
| | honor a sequential prefetch request because the |
| | sequential prefetch threshold was reached. |
+------------------+--------------------------------------------------+
| DefWr% | The deferred write threshold value of the pool. |
+------------------+--------------------------------------------------+
| DefWrite | Specifies the number of times the buffer pool |
| | has had at least 50 percent of the buffers |
| | unavailable and DB2 was forced to perform write |
| | I/O operations to bring the percent of |
| | unavailable buffers below 50 percent. |
+------------------+--------------------------------------------------+
| DsDfWr% | The vertical deferred write threshold value of |
| | the buffer pool. |
+------------------+--------------------------------------------------+
| DsDefWr | Indicates the number of times the vertical |
| | deferred write threshold was reached. |
+------------------+--------------------------------------------------+
| DsDfWrBuf | Displays the buffer pool vertical wrte threshold |
| | in number of buffers. |
+------------------+--------------------------------------------------+
| PSeqStl% | Specifies the virtual pool parallel sequential |
| | threshold. |
+------------------+--------------------------------------------------+
| AsPSeq% | Indicates the assisting parallel sequential |
| | threshold |
+------------------+--------------------------------------------------+
| SeqSyncRd | Displays the number of synchronous read I/Os |
| | issued by sequential access requesters. These |
| | occur when a prefetch request is suspended in |
| | order to do an I/O. |
+------------------+--------------------------------------------------+
| SeqGetPgs | Indicates the number of getpage requests issued |
| | by sequential access requesters (after list or |
| | sequential prefetch requests). |
+------------------+--------------------------------------------------+
| ASynWrIo | Displays the number of buffer pool write I/O |
| | operations that DB2 was able to process |
| | asynchronously. |
+------------------+--------------------------------------------------+
| ASynRdIo | Displays the number of buffer pool read I/O |
| | operations that DB2 was able to process |
| | asynchronously. The number is the sum of |
| | prefetch sequential, prefetch list, and prefetch |
| | dynamic I/O. |
+------------------+--------------------------------------------------+
| SyncWrIo | Displays the number of buffer pool write I/O |
| | operations that required the application to wait |
| | until they completed. |
+------------------+--------------------------------------------------+
| PgWrtEff | Indicates the ratio of how many buffer pool |
| | pages are being written per WRITE I/O operation. |
+------------------+--------------------------------------------------+
| LogPgLst | Displays the number of times one or more pages |
| | were added to the logical page list (LPL). |
+------------------+--------------------------------------------------+
| PrfSeqRq | Indicates the number of requests for a prefetch |
| | operation. |
+------------------+--------------------------------------------------+
| PrfSeqPg | Indicates the number of pages that have been |
| | read into the buffer pool using sequential |
| | prefetch I/O operations. |
+------------------+--------------------------------------------------+
| PrfSeqIo | Displays the number of sequential prefetch read |
| | I/O requests for the associated buffer pool. |
+------------------+--------------------------------------------------+
| PrfLstRq | Indicates the number of requests for a list |
| | prefetch operation. |
+------------------+--------------------------------------------------+
| PrfLstPg | Indicates the number of asynchronous page reads |
| | because of list prefetch. |
+------------------+--------------------------------------------------+
| PrfLstIo | Displays the number of asynchronous read I/Os |
| | because of list prefetch. |
+------------------+--------------------------------------------------+
| PrfDynRq | Displays the number of dynamic prefetch requests |
| | performed due to sequential detection. |
+------------------+--------------------------------------------------+
| PrfDynPg | Displays the Number of asynchronous page reads |
| | because of dynamic prefetch. |
+------------------+--------------------------------------------------+
| PrfDynIo | Displays the number of asynchronous read I/Os |
| | because of dynamic prefetch. |
+------------------+--------------------------------------------------+
| PrfMxStr | Indicates the highest number of concurrent |
| | prefetch I/O streams that were allocated for |
| | supporting queries processed in parallel in this |
| | buffer pool. |
+------------------+--------------------------------------------------+
| ParaIoRq | Specifies the total number of requests made for |
| | processing queries in parallel in this buffer |
| | pool. This counter is applicable only for |
| | non-work file page sets and when queries are |
| | processing in parallel in DB2. |
+------------------+--------------------------------------------------+
| CastPg | Indicates the number of pages written for |
| | castout I/O operations. |
+------------------+--------------------------------------------------+
| CastIo | Indicates the number of castout I/O operations. |
+------------------+--------------------------------------------------+
| CastPgIo | Displays the average number of castout pages per |
| | castout I/O operation. |
+------------------+--------------------------------------------------+
| PageIoRd | Displays the number of times a buffer pool |
| | buffer had to be paged in to satisfy a READ I/O |
| | request. |
+------------------+--------------------------------------------------+
| PageIoWr | Indicates the number of times a buffer pool |
| | buffer had to be paged in from a paging data set |
| | in order to satisfy a WRITE I/O request. |
+------------------+--------------------------------------------------+
| DisEngRd | Indicates the number of times that DB2 failed to |
| | honor a sequential prefetch request due to a |
| | shortage of READ engines (SRBs). DB2 has a |
| | maximum number of SRBs with which to perform |
| | READ I/O operations to the buffer pool. |
+------------------+--------------------------------------------------+
| IneffSrt | Displays the number of times a merge pass could |
| | not be efficiently peformed due to a shortage of |
| | space in the buffer pool. |
+------------------+--------------------------------------------------+
| PoolFull | Specifies the number of times DB2 tried to |
| | expand the buffer pool but failed to do so |
| | because the pool was already expanded to its |
| | limit. |
+------------------+--------------------------------------------------+
| ExFailGm | Indicates the number of times DB2 tried to |
| | expand the buffer pool but failed due do so |
| | because of insufficient storage in DB2's |
| | database services address space (DBM1). |
+------------------+--------------------------------------------------+
| RecallTO | Indicates the number of times DB2 encountered a |
| | migrated database data set and issued a recall |
| | request to HSM, but the wait period for the |
| | recall was exceeded. |
+------------------+--------------------------------------------------+
| CndGtPgf | Displays the number of times a page requested |
| | for a query processed in parallel was unavailable|
| | because an I/O was in progress or the page was |
| | not found in the buffer pool. The agent does not |
| | wait. Instead, control returns to the agent and |
| | asynchronous prefetch I/O is triggered. |
+------------------+--------------------------------------------------+
| ParDegReds | Indicates the number of requested prefetch I/O |
| | streams that were denied because of a storage |
| | shortage in the buffer pool. |
+------------------+--------------------------------------------------+
| ParRedIos | Indicates the number of times that DB2 could not |
| | allocate the requested number of buffer pages to |
| | allow a parallel group to run to the planned |
| | degree. |
+------------------+--------------------------------------------------+
| AvgDegRed | Displays the average number of parallel I/O |
| | streams that were not used because of |
| | insufficient buffer pool space. |
+------------------+--------------------------------------------------+
| PrfReHalf | Indicates the number of occurrences when the |
| | prefetch quantity is reduced from normal to |
| | one-half of normal. |
+------------------+--------------------------------------------------+
| PrfReFrth | Indicates the number of occurrences when the |
| | prefetch quantity is reduced from normal to |
| | one-quarter of normal. |
+------------------+--------------------------------------------------+
| WfNoCre | Shows the number of times a workfile could not |
| | be created due to insufficient buffer resources |
| | for sequential processing. |
+------------------+--------------------------------------------------+
| WfNoSort | Displays the number of times a merge pass could |
| | be performed due to a shortage of space in the |
| | buffer pool. |
+------------------+--------------------------------------------------+
| WfPrfAbt | Displays the number of times sequential prefetch |
| | has been disabled for a workfile because the |
| | dynamic prefetch quantity is zero. |
+------------------+--------------------------------------------------+
| WfMxAllo | Displays the maximum number of workfiles that |
| | have been allocated during sort/merge processing.|
+------------------+--------------------------------------------------+
| WfSortRq | Indicates the total number of workfiles that |
| | have been requested for all sort/merge passes. |
+------------------+--------------------------------------------------+
| SrtMrgRq | Indicates the number of merge passes requested |
| | for DB2 sort activities. |
+------------------+--------------------------------------------------+
| DestRdPg | Displays the number of pages for which |
| | destructive read was requested. |
+------------------+--------------------------------------------------+
| PagWrByp | Indicates the number of pages dequeued from the |
| | vertical deferred write queue (VDWQ) for |
| | destructive read requests. |
+------------------+--------------------------------------------------+
| DsMigOpn | Indicates the number of times DB2 encountered a |
| | migrated database dataset and issued a recall to |
| | DFHSM. |
+------------------+--------------------------------------------------+
| Id | The buffer pool identifier number. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
DBDSETS

DBDSETS Command

The DBDSETS command displays a list of all currently open data


sets in the DB2 DBM1 address space and information on their use
and extent allocation.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DBDSETs | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | If the command supports cross system data |
| | collection, this parameter forces cross system |
| | data collection to be off for this execution, |
| | but the current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Db2 subsystems |
| | on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of Db2 subsystems to be displayed. The list of |
| | available groups with type DB2SSID can be found |
| | on the GROUPS command. A group name of "*" can |
| | be entered to indicate that no group processing |
| | is required. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| DB2 | The Db2 version if the current address space is |
| | a Db2 address space. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem identifier if the current |
| | address space is a Db2 address space. |
+------------------+--------------------------------------------------+
| Mode | Specifies the current mode. |
| | Possible value are: |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
+------------------+--------------------------------------------------+
| Group | Current DB2SSID group name specified by the |
| | GROUP command parameter. |
| | This entry is displayed only when a group has |
| | been specified. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SSID | The DB2 subsystem ID. |
+------------------+--------------------------------------------------+
| DatasetName | The pageset's data set name as constructed by |
| | DB2. The high-level qualifier is determined by |
| | the VCAT parameter in the database definition. |
| | The second qualifier is always DSNDBC. The third |
| | qualifier is the database name. The fourth part |
| | is the pageset (table or indexspace) name. The |
| | last qualifier indicates the partition number |
| | (non-partitioned pagesets always have A001). |
+------------------+--------------------------------------------------+
| Extents | The number of extents taken by the data set. |
+------------------+--------------------------------------------------+
| HFmtPage | The highest page formatted in the data set. |
+------------------+--------------------------------------------------+
| HAlcPage | The highest page allocated to the data set. If |
| | the allocation is much higher than the formatted |
| | value, the data set may be over allocated. |
+------------------+--------------------------------------------------+
| HReqPage | The high requested relative page number. |
+------------------+--------------------------------------------------+
| ErrorStart | The starting page range on which I/O errors have |
| | occurred. |
+------------------+--------------------------------------------------+
| ErrorEnd | The ending page range on which I/O errors have |
| | occurred. |
+------------------+--------------------------------------------------+
| MMIB | Address of the pageset's media manager interface |
| | block (MMIB). |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| DSinfo | Invokes the DSINFO command for the data set |
| Info | name. |
+------------------+--------------------------------------------------+
| LC | Invokes the LISTCAT command for the current |
| | data set. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
DBERRMSG

DBERRMSG Command

The DBERRMSG command displays the last set of WTO messages recorded by
DB2 through IFCID 197 since the request was last started.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DBERRMsg | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | If the command supports cross system data |
| | collection, this parameter forces cross system |
| | data collection to be off for this execution, |
| | but the current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Db2 subsystems |
| | on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of Db2 subsystems to be displayed. The list of |
| | available groups with type DB2SSID can be found |
| | on the GROUPS command. A group name of "*" can |
| | be entered to indicate that no group processing |
| | is required. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| DB2 | The Db2 version if the current address space is |
| | a Db2 address space. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem identifier if the current |
| | address space is a Db2 address space. |
+------------------+--------------------------------------------------+
| Mode | Specifies the current mode. |
| | Possible value are: |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
+------------------+--------------------------------------------------+
| Group | Current DB2SSID group name specified by the |
| | GROUP command parameter. |
| | This entry is displayed only when a group has |
| | been specified. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SSID | The DB2 subsystem ID. |
+------------------+--------------------------------------------------+
| Date | The date when the trace record was produced. |
| | This value will be populated only for the first |
| | line of a multi-line WTO. |
+------------------+--------------------------------------------------+
| Time | The time when the trace record was produced. |
| | This value will be populated only for the first |
| | line of a multi-line WTO. |
+------------------+--------------------------------------------------+
| MsgID | Specifies the message ID. This value will be |
| | populated only for the first line of a |
| | multi-line WTO. |
+------------------+--------------------------------------------------+
| Message | The WTO message text. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.
Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
DBLOGAL

DBLOGAL Command

The DBLOGAL command displays a list of logs allocated and their


current usage and status. One row is returned for each log data set
allocated.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DBLOGAl | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | If the command supports cross system data |
| | collection, this parameter forces cross system |
| | data collection to be off for this execution, |
| | but the current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Db2 subsystems |
| | on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of Db2 subsystems to be displayed. The list of |
| | available groups with type DB2SSID can be found |
| | on the GROUPS command. A group name of "*" can |
| | be entered to indicate that no group processing |
| | is required. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| DB2 | The Db2 version if the current address space is |
| | a Db2 address space. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem identifier if the current |
| | address space is a Db2 address space. |
+------------------+--------------------------------------------------+
| Mode | Specifies the current mode. |
| | Possible value are: |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
+------------------+--------------------------------------------------+
| Group | Current DB2SSID group name specified by the |
| | GROUP command parameter. |
| | This entry is displayed only when a group has |
| | been specified. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SSID | The DB2 subsystem ID. |
+------------------+--------------------------------------------------+
| DatasetName | The data set name of the active logs currently |
| | allocated to DB2. |
+------------------+--------------------------------------------------+
| Status | The status of the associated log data set. Valid |
| | values are: |
| | |
| | CURRENT - Log DB2 is currently writing to |
| | AVAIL - Available log data set |
| | FULL - Log data set is 100 percent full |
| | NEW-AVAL - Available log data set that has never |
| | been used |
| | STOPPED - Log data set is stopped and not |
| | available |
| | ARCH-IAL - Archive input allocated data set |
| | ARCH-IMP - Archive input mount pending data set |
| | ARCH-IN - Archive input data set |
| | ARCH-OAL - Archive output allocated data set |
| | ARCH-OMP - Archive output mount pending data set |
| | ARCH-OUT - Archive output data set |
+------------------+--------------------------------------------------+
| BlkCnt | The size of the active log data set in 4 KB |
| | blocks. |
+------------------+--------------------------------------------------+
| Pct | The current percent utilization of the active |
| | logs. 100 percent implies that the active log |
| | has filled and has not been offloaded yet. |
+------------------+--------------------------------------------------+
| StrDate | The date when the first record was written to |
| | the log. |
+------------------+--------------------------------------------------+
| StrTime | The time when the first record was written to |
| | the log. |
+------------------+--------------------------------------------------+
| EndDate | The date when the last record was written to the |
| | log. |
+------------------+--------------------------------------------------+
| EndTime | The time when the last record was written to the |
| | log. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| DSinfo | Invokes the DSINFO command for the data set |
| Info | name. |
+------------------+--------------------------------------------------+
| LC | Invokes the LISTCAT command for the current |
| | data set. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
DBLOGCKP

DBLOGCKP Command

The DBLOGCKP command displays checkpoint information and select ZPARM


settings for logging. Only one row will be returned.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DBLOGAl | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | If the command supports cross system data |
| | collection, this parameter forces cross system |
| | data collection to be off for this execution, |
| | but the current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Db2 subsystems |
| | on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of Db2 subsystems to be displayed. The list of |
| | available groups with type DB2SSID can be found |
| | on the GROUPS command. A group name of "*" can |
| | be entered to indicate that no group processing |
| | is required. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| DB2 | The Db2 version if the current address space is |
| | a Db2 address space. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem identifier if the current |
| | address space is a Db2 address space. |
+------------------+--------------------------------------------------+
| Mode | Specifies the current mode. |
| | Possible value are: |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
+------------------+--------------------------------------------------+
| Group | Current DB2SSID group name specified by the |
| | GROUP command parameter. |
| | This entry is displayed only when a group has |
| | been specified. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SSID | The DB2 subsystem ID. |
+------------------+--------------------------------------------------+
| LogMode | Indicates whether single or dual active logging |
| | is enabled. |
| | |
| | This parameter is defined through the SYSTEM |
| | RESOURCE DATA SET installation panel and is |
| | assembled as the TWOACTV parameter of the |
| | DSN6LOGP. |
+------------------+--------------------------------------------------+
| Freq | Indicates the number of minutes between |
| | checkpoints if the value is between 1 and 60. |
| | Otherwise, the value represents the number of |
| | log records to be written between checkpoints. |
| | |
| | The checkpoint frequency is specified on the |
| | Active Log Data Set Parameters installation |
| | panel and is assembled as the CHKFREQ parameter |
| | of the DSN6SYSP macro. |
+------------------+--------------------------------------------------+
| Active | The current number of active logs allocated. |
+------------------+--------------------------------------------------+
| Taken | Indicates the number of checkpoints DB2 has |
| | taken. |
| | |
| | The frequency of checkpoints is controlled by |
| | the DSNZPARM LOGLOAD parameter. Checkpoints are |
| | used during DB2 restart processing to determine |
| | how far back in the logs DB2 needs to process |
| | during restart recovery. The more frequent your |
| | checkpoints, the less time DB2 will take to |
| | restart. |
| | |
| | However, you do not want to take checkpoints too |
| | frequently because a checkpoint is an expensive |
| | process in terms of CPU and I/O to the active |
| | log. Checkpoints cause all updated buffers in |
| | the buffer pool to be written to DASD, thus |
| | reducing the number of pages written per WRITE |
| | I/O. Furthermore, if an application is |
| | performing updates during a checkpoint |
| | operation, the application may be forced to wait |
| | for the update to be written to DASD before |
| | continuing (synchronous WRITE I/O). |
| | |
| | Therefore, strive for a balance when setting |
| | your LOGLOAD parameter. As a general rule, plan |
| | for checkpoints to be taken every 10 to 15 |
| | minutes. |
+------------------+--------------------------------------------------+
| Size | The size of the output buffer used for writing |
| | active and archive log data sets. |
+------------------+--------------------------------------------------+
| Delta | The average number of minutes between DB2 |
| | checkpoints. |
| | |
| | The frequency of checkpoints is controlled by |
| | the DSNZPARM LOGLOAD parameter. Checkpoints are |
| | used during DB2 restart processing to control |
| | how far back in the logs DB2 needs to process |
| | during restart recovery. In other words, the |
| | more frequent your checkpoints, the less time |
| | DB2 will take to restart. |
| | |
| | However, you do not want to take checkpoints too |
| | frequently because checkpoint is an expensive |
| | process in terms of CPU and I/O to the active |
| | log. Note that checkpoints cause all updated |
| | buffers in the buffer pool to be written to |
| | DASD, thus reducing the number of pages written |
| | per WRITE I/O. Furthermore, if an application is |
| | performing updates during a checkpoint |
| | operation, the application may be forced to wait |
| | for the update to be written to DASD before |
| | continuing (synchronous WRITE I/O). |
| | |
| | Therefore, you want to strive for a "happy |
| | medium" when setting your LOGLOAD parameter. As |
| | a general rule, plan for checkpoints to be taken |
| | every 10 to 15 minutes. |
+------------------+--------------------------------------------------+
| ArcMode | Indicates whether single or dual active logging |
| | is enabled. |
| | |
| | This parameter is defined through the SYSTEM |
| | RESOURCE DATA SET NAMES panel and is assembled |
| | as the TWOACTV parameter of the DSN6LOGP. |
+------------------+--------------------------------------------------+
| Recs | The number of DB2 log records that need to be |
| | written before the next checkpoint is taken. |
+------------------+--------------------------------------------------+
| Type | Indicates if the current checkpoint frequency |
| | type is for a number of minutes (MINUTES) or |
| | number of log records (LOGRECS). |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
DBPRMBP

DBPRMBP Command

The DBPRMBP command displays parameter information for each buffer


pool.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DBPRMBp | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | If the command supports cross system data |
| | collection, this parameter forces cross system |
| | data collection to be off for this execution, |
| | but the current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Db2 subsystems |
| | on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of Db2 subsystems to be displayed. The list of |
| | available groups with type DB2SSID can be found |
| | on the GROUPS command. A group name of "*" can |
| | be entered to indicate that no group processing |
| | is required. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| DB2 | The Db2 version if the current address space is |
| | a Db2 address space. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem identifier if the current |
| | address space is a Db2 address space. |
+------------------+--------------------------------------------------+
| Mode | Specifies the current mode. |
| | Possible value are: |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
+------------------+--------------------------------------------------+
| Group | Current DB2SSID group name specified by the |
| | GROUP command parameter. |
| | This entry is displayed only when a group has |
| | been specified. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SSID | The DB2 subsystem ID. |
+------------------+--------------------------------------------------+
| Pool | The name of the buffer pool. |
+------------------+--------------------------------------------------+
| Size | The size of the virtual buffer pool. |
+------------------+--------------------------------------------------+
| DefWrThr | The deferred write threshold of the buffer pool. |
+------------------+--------------------------------------------------+
| VrtSeqThr | The sequential steal (remove and replace) |
| | threshold of the virtual buffer pool. |
+------------------+--------------------------------------------------+
| VrtWrThr | The vertical deferred write threshold of the |
| | buffer pool. This value is between 0 and 90. |
+------------------+--------------------------------------------------+
| ParIOSeqThr | The parallel sequential threshold of the virtual |
| | buffer pool. It is used to support parallel |
| | operations. This value is between 0 and 100. |
+------------------+--------------------------------------------------+
| AstParSeqThr | The assisting parallel sequential threshold. |
+------------------+--------------------------------------------------+
| PgFix | Indicates whether a page is fixed in real |
| | storage when it is first used. |
+------------------+--------------------------------------------------+
| VrtWrThrBuf | The buffer pool vertical write threshold, in |
| | number of buffers. This value determines the |
| | threshold only if VBDPVDQT is zero and QDBPVDQB |
| | is non-zero. |
+------------------+--------------------------------------------------+
| PgSteal | The page stealing (remove and replace) algorithm |
| | to be used for the virtual buffer pool. Valid |
| | values are: |
| | |
| | LRU - Least Recently Used |
| | FIFO - First In First Out |
+------------------+--------------------------------------------------+
| AutoSize | Indicates whether automatic buffer pool size |
| | management is enabled. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
DBPRMGBP

DBPRMGBP Command

The DBPRMGBP command displays parameter information for each group


buffer pool connected to this DB2 data sharing member.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DBPRMGbp | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | If the command supports cross system data |
| | collection, this parameter forces cross system |
| | data collection to be off for this execution, |
| | but the current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Db2 subsystems |
| | on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of Db2 subsystems to be displayed. The list of |
| | available groups with type DB2SSID can be found |
| | on the GROUPS command. A group name of "*" can |
| | be entered to indicate that no group processing |
| | is required. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| DB2 | The Db2 version if the current address space is |
| | a Db2 address space. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem identifier if the current |
| | address space is a Db2 address space. |
+------------------+--------------------------------------------------+
| Mode | Specifies the current mode. |
| | Possible value are: |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
+------------------+--------------------------------------------------+
| Group | Current DB2SSID group name specified by the |
| | GROUP command parameter. |
| | This entry is displayed only when a group has |
| | been specified. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SSID | The DB2 subsystem ID. |
+------------------+--------------------------------------------------+
| Pool | The group buffer pool name. Valid values are: |
| | GBP0 to GBP49 and GBP32K to GBP32K9. |
+------------------+--------------------------------------------------+
| ID | The internal ID number of the group buffer pool. |
+------------------+--------------------------------------------------+
| Error | The status of statistics collection. Valid |
| | values are: |
| | |
| | NONE - No errors in collecting data. |
| | SCA - Error in reading group buffer |
| | pool attributes from the |
| | shared communications area |
| | (SCA). |
| | DB2 - Addressing error while |
| | accessing DB2 control blocks. |
+------------------+--------------------------------------------------+
| RtnCd | The return code from statistics collection |
| | routine. |
+------------------+--------------------------------------------------+
| Rsn | The reason code from the statistics collection |
| | routine. |
+------------------+--------------------------------------------------+
| CurRatio | The current directory entry to data entry ratio |
| | This is the number of directory entries that |
| | exist for each data page. |
+------------------+--------------------------------------------------+
| PndRatio | The pending directory entry to data entry ratio. |
| | This is the value specified for the ratio option |
| | on the ALTER GROUPBUFFERPOOL command. This value |
| | takes effect the next time the group buffer pool |
| | is allocated. If an ALTER BUFFERPOOL command was |
| | not issued, the value in this field equals |
| | QBGBGR1. |
+------------------+--------------------------------------------------+
| Classt | The castout class threshold. This is the value |
| | specified for the CLASST option on the ALTER |
| | GROUPBUFFERPOOL command. This option changes |
| | the threshold at which class castout is started. |
+------------------+--------------------------------------------------+
| GBPoolt | The group buffer pool threshold. This is the |
| | value specified for the GBPOOLT option on the |
| | ALTER GROUPBUFFERPOOL command. This option |
| | changes the threshold at which data in the group |
| | buffer pool is cast out to DASD. |
+------------------+--------------------------------------------------+
| AutoRec | Specifies the current automatic recovery |
| | (AUTOREC) setting for the group buffer pool. |
+------------------+--------------------------------------------------+
| GBPCache | Specifies the current GBPCACHE setting. |
+------------------+--------------------------------------------------+
| GBPChkpt | The group buffer pool checkpoint interval in |
| | minutes. This is the interval specified on the |
| | GBPCHKPT option on the ALTER GROUPBUFFERPOOL |
| | command. This option changes the time interval |
| | between successive checkpoints of the group |
| | buffer pool. |
+------------------+--------------------------------------------------+
| BufPages | The size of the group buffer pool allocated in 4 |
| | K increments. |
+------------------+--------------------------------------------------+
| DirEntAlc | The actual number of directory entries that were |
| | allocated. A directory entry contains control |
| | information for one database page. |
+------------------+--------------------------------------------------+
| DatEntAlc | The actual number of allocated data entries. |
| | Data entries are the places where the data pages |
| | reside. |
+------------------+--------------------------------------------------+
| DirEntRcl | The number of times that a page name assignment |
| | required that a coupling facility directory |
| | entry be reclaimed (stolen). |
+------------------+--------------------------------------------------+
| DatEntRcl | The number of times that a page name assignment |
| | required that a coupling facility data entry be |
| | reclaimed (stolen). |
+------------------+--------------------------------------------------+
| DirEntStl | The number of times that a directory entry was |
| | stolen and XI signals had to be sent because the |
| | page in the directory entry was cached in one or |
| | more DB2 buffer pools. |
+------------------+--------------------------------------------------+
| DatEntChg | The number of allocated data entries that are |
| | currently in changed state (snapshot value, not |
| | cumulative). |
+------------------+--------------------------------------------------+
| Mode | The mode for the group buffer pool. Valid values |
| | are DUPLEX or SIMPLEX. |
+------------------+--------------------------------------------------+
| SecBufPgs | The size of the secondary group buffer pool |
| | allocated in 4 KB increments. This counter |
| | applies only if the group buffer pool is |
| | duplexed. |
+------------------+--------------------------------------------------+
| SecDirEnt | The actual number of directory entries that were |
| | allocated for the secondary group buffer pool. |
| | A directory entry contains control information |
| | for one database page. This counter applies only |
| | if the group buffer pool is duplexed. |
+------------------+--------------------------------------------------+
| SecDatEnt | The actual number of data entries that were |
| | allocated for the secondary group buffer pool. |
| | Data entries are the places where the data pages |
| | reside. This counter applies only if the group |
| | buffer pool is duplexed. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
DBPRMS

DBPRMS Command

The DBPRMS command displays current DB2 system parameters (ZPARMs).

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DBPRMS | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | If the command supports cross system data |
| | collection, this parameter forces cross system |
| | data collection to be off for this execution, |
| | but the current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Db2 subsystems |
| | on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of Db2 subsystems to be displayed. The list of |
| | available groups with type DB2SSID can be found |
| | on the GROUPS command. A group name of "*" can |
| | be entered to indicate that no group processing |
| | is required. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| DB2 | The Db2 version if the current address space is |
| | a Db2 address space. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem identifier if the current |
| | address space is a Db2 address space. |
+------------------+--------------------------------------------------+
| Mode | Specifies the current mode. |
| | Possible value are: |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
+------------------+--------------------------------------------------+
| Group | Current DB2SSID group name specified by the |
| | GROUP command parameter. |
| | This entry is displayed only when a group has |
| | been specified. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SSID | The DB2 subsystem ID. |
+------------------+--------------------------------------------------+
| Category | Logical grouping of options. |
+------------------+--------------------------------------------------+
| Option | Option. Refer to Related Information section |
| | for possible options and their descriptions. |
+------------------+--------------------------------------------------+
| Value | Value. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Help | Invokes the HELP command for DBPRMS locating |
| | the Option. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+

Related Information

DB2 System parameters

Option Description
----------------------------- --------------------------------------
ASSEMBLY-DATE The date the DSNZPARM member was
PARMS-ASSEMBLED assembled.

ZPARMS-NAME The assembled member name of the ZPARM


module.

CATALOG The alias of the VSAM integrated


catalog facility (ICF) catalog in
which the DB2 system catalog and
directory data sets are defined.

This parameter is defined through the


DATA PARAMETERS panel and is assembled
as the CATALOG parameter of the
DSN6SPRM macro.

IDBACK The maximum number of concurrent


connections identified to DB2 from
batch. Each of the following is
counted as a separate batch
connection:

- Each batch job using DSN processor


- Each batch job using call attach
- Each DB2 utility

When the number of batch jobs


attempting to access DB2 exceeds this
number, excess connection requests are
rejected. This parameter is defined
through the STORAGE SIZES panel and is
assembled as the IDBACK parameter of
the DSN6SYSP macro.

IDFORE The maximum number of users allowed to


be identified to DB2 from TSO
foreground at the same time. Each of
the following is counted as a separate
TSO user:

- Each TSO user using DSN processor


- Each TSO user using call attach
When the number of TSO users
attempting to access DB2 exceeds this
number, excess connection requests are
rejected. This parameter is defined
through the STORAGE SIZES panel and is
assembled as the IDFORE parameter of
the DSN6SYSP macro.

CTHREAD The maximum number of allied threads


(threads started at the local
subsystem) that can be allocated
concurrently. Each of the following is
counted as a separate thread:

- Each TSO user (DSN processor)


- Each batch job (DSN processor
/utility)
- Each IMS region accessing DB2
- Each CICS transaction accessing
DB2
- Each call attach task accessing
DB2

The total number of users that can


access DB2 is the sum of this value
and the remote users value. When the
number of users attempting to access
DB2 exceeds this number, then the
excess plan allocation requests are
queued.

This parameter is defined through the


STORAGE SIZES panel and is assembled
as the CTHREAD parameter of the
DSN6SYSP macro.

RTHREAD The maximum number of database access


threads (DBATs) that can be allocated
concurrently (active DBATs).

The total number of users that can


access DB2 is the sum of this value
and the concurrent users value. When
the number of users attempting to
access DB2 remotely exceeds this
number, then the excess allocation
requests are queued.

This parameter is defined through the


STORAGE SIZES panel and is assembled
as the MAXDBAT parameter of the
DSN6SYSP macro.

MAX-CONCURRENT-REMOTE The maximum number of concurrent


remote threads, both active and
inactive.

NUMLKUS The maximum number of page or row


locks that a single application can
hold concurrently on all table spaces.
Single program on a single table. The
maximum includes page or row locks on
both the index and table. The limit
applies to all table spaces defined
with LOCKSIZE PAGE, ROW or ANY
options.

A value of zero implies that there is


no limit to the number of page or row
locks a program can acquire.

This parameter is defined through the


IRLM PANEL 2 panel and is assembled as
the NUMLKUS parameter of the DSN6SPRM
macro.

NUMLKTS The maximum number of page or row


locks that can be held concurrently by
a single program on a single table
space for non-segmented table spaces
defined with LOCKSIZE ANY. For
segmented table spaces defined with
LOCKSIZE ANY, this value shows the
maximum number of page or row locks
that can be held concurrently by a
single program on a single table. The
maximum includes page or row locks on
both the index and table.

A value of zero implies that lock


escalation is disabled. When a program
is bound without lock escalation it
almost always acquires a table space
lock, or a table lock if segmented, on
a table space defined as LOCKSIZE ANY.

This parameter is defined through the


IRLM PANEL 2 panel and is assembled as
the NUMLKTS parameter of the DSN6SPRM
macro.

DSMAX The maximum number of concurrent


database data sets that DB2 should try
to have allocated and open.

This parameter is not directly


definable through any installation
panel, but is assembled as the DSMAX
parameter of the DSN6SPRM macro.

SEQ-CACHE Indicates whether to use sequential


mode to read cached data from a 3390-3
DASD device.

This 3390-3 cache parameter is defined


through the STORAGE SIZES panel and is
assembled as the SEQCACH parameter of
the DSN6SPRM macro.

If you have the appropriate device,


this option can improve performance by
transferring data between DASD and
cache by the cylinder instead of by
the track.

DBCHK Database checking enablement.

CHECKPOINTS The number of checkpoints a data set


that was not updated must go through
before being selected as a
pseudo-close candidate.

This parameter is not directly


definable through any installation
panel, but is assembled as the PCLOSEN
parameter of the DSN6SYSP macro.

MIN-TO-PSEUDOCLOSE The amount of time, in minutes, that


must elapse before a data set can be a
candidate for pseudo-close.

This parameter is not directly


definable via any installation panel,
but is assembled as the PCLOSET
parameter of the DSN6SYSP macro.

INDEX-TYPE The default index type value. This


value indicates whether type 1 or type
2 indexes will be created by default
when no index type is specified on the
CREATE INDEX statement.

The default index type is not


specified on any installation panel,
but it is assembled as the DEFIXTP
parameter of the DSN6SPRM macro.

MAX-KEPT-DYNAMIC The maximum number prepared dynamic


statements saved past commit. This
parameter corresponds to field "max
kept dyn stmts" on installation panel
DSNTIPE.

ZPARM name: MAXKEEPD in DSN6SPRM.

LOB-KBYTES-AGENT The current max user LOB storage


value. The value in this field
establishes an upper limit for the
amount of storage each user can have
for storing LOB values. The value
specified gives the numbers of KB.

The "max user LOB storage" is


specified on the "Storage Sizes"
installation panel, and is assembled
as the LOBVALA parameter of the
DSN6SYSP macro.

LOB-MBYTES-SYSTEM The current max system LOB storage


value. The value in this field
establishes an upper limit for the
amount of storage the system can have
for storing LOB values. The value
specified gives the numbers of MB.

The "max system LOB storage" is


specified on the "Storage Sizes"
installation panel, and is assembled
as the LOBVALS parameter of the
DSN6SYSP macro.

CONTR-DBM1-STORAGE Indicates whether DB2 periodically


contracts each thread's working
storage area. The default is NO.

The contract thread storage value is


not defined through any installation
panel, but is assembled as the
CONTSTOR parameter of the DSN6SPRM
macro.

MAX-LE-TOKENS The maximum number of language


environment tokens that are active at
any time. Valid values are 0 to 50.
The default is 20.

Install parameter: Maximum LE Tokens


on panel DSNTIP7, or ZPARM name: LEMAX
in DSN6SPRM.

MIN-MANAGED-STORE The "manage thread storage" value. The


value in this field indicates whether
or not DB2 will use storage management
algorithms that minimize the amount of
working storage consumed by individual
threads. For best performance, this
parameter should be NO. For subsystems
that have many long-running threads
and are constrained on storage in the
DBM1 address space, specifying YES can
reduce the total storage used in the
DBM1 address space.

The "manage thread storage" is


specified on the "Thread Management"
installation panel, and is assembled
as the MINSTOR parameter of the
DSN6SPRM macro.

PADIX Specifies whether new indexes should


be padded by default. YES indicates
that a new index will be padded unles
the NOT PADDED option is specified on
the CREATE INDEX statement. The
default value, NO, indicates that a
new index will not be padded unless
the PADDED option is specified on the
CREATE INDEX statement.

This parameter only affects indexes


that have at least one varying-length
column.

This parameter is defined through the


"Thread Management" panel and is
assembled as the PADIX parameter of
the DSN6SPRM macro.

UNCOMMITED-RD-WARN-THRSH The number of minutes that a read


claim is held by an agent before DB2
writes an IFCID 0313 record to report
it as a long-running reader. This
parameter corresponds to field
"long-running reader" on installation
panel.

This parameter is defined via the


"Thread Management" panel, and is
assembled as the LRDRTHLD parameter of
the DSN6SPRM macro.

COMCRIT Indicates whether to use common


criteria for all tables.

SUPPRESS-TS-CONV-WARNING Indicates whether to suppress TS


conversion warnings.

OTC-LICENSE Specifies whether this DB2 subsystem


or data sharing member operates under
an OTC license, the terms of which
have been accepted. Valid values are:

NOT_USED - Indicates that an


OTC license is not
in effect on this
DB2. This is the
default.

TERMS_ACCEPTED - Indicates that an


OTC license is in
effect on this DB2
and that the owner
accepts the terms of
that license.

OPTIOWGT Specifies how the DB2 Optimizer should


balance I/O cost and CPU cost
estimation when selecting an access
path. Valid settings are:

DISABLE - (The default): Use


the DB2 standard
balance

ENABLE - Use a lower I/O cost


weighting

ZPARM name: OPTIOWGT in DSN6SPRM.

OPTIXOPREF Enable PK51734 optimizer enhancements


Valid values are OFF and ON. The
default is OFF.

ZPARM name: OPTIXOPREF in DSN6SPRM.


OPTJBPR Enable PK69074 optimizer enhancements
Valid values are OFF and ON. The
default is OFF.

ZPARM name: OPTJBPR in DSN6SPRM.

OPTCCOS4 Enable PK26760 optimizer enhancements.


Valid values are OFF and ON. The
default is OFF.

ZPARM name: OPTCCOS4 in DSN6SPRM.

FREE-LCLCACHE-STMT Indicates whether DB2 can free


statements from the dynamic statement
cache to relieve storage constraints
below the 2GB bar. This parameter
applies only for packages or plans
that are bound with KEEPDYNAMIC(YES).
Possible values are:

- 0: DB2 cannot free statements from


the cache.
- 1: DB2 can free statements from
the cache.

ZPARM name: CACHEDYN_FREELOCAL in


DSN6SPRM.

MAX-CONCUR-PKG-OP The maximum number of package requests


that can be processed simultaneously.

ZPARM name: MAX_CONCURRENT_PKG_OPS in


DSN6SPRM.

LOB-FILE-DSMAX The maximum number of concurrently


open data sets for processing LOB file
references.

This value corresponds to "max open


file refs" on installation panel
DSNTIPE, or ZPARM name: MAXOFILR in
DSN6SYSP.

DDF-START Specifies whether DB2 loads DDF, and


if DDF is loaded, how to start it. The
following values are valid:

NO - DDF is not loaded at DB2


startup, and that it can
not be started with a
command.

AUTO - DDF is automatically


initialized and started when
the DB2 subsystem is
started. The DDF address
space is started as part of
DDF initialization.

COMMAND - DDF is initialized at DB2


startup and is prepared to
receive the -START DDF
command. The DDF address
space is started as part of
DDF initialization.

This parameter is defined through the


DISTRIBUTED DATA FACILITY panel and is
assembled as the DDF parameter of the
DSN6FAC macro.

RLFERRD Shows what action DB2 takes if the


resource limit facility encounters
some error that prevents it from
accessing the resource limit
specification table (RLST) during a
query request from another DB2.

Common errors include not finding a


qualifying row from the RLST.

The following values are valid:

NOLIMIT - Allows a remote query to


run without a limit.

NORUN - Terminates the remote query


immediately.

A numerical value represents the


number of CPU service units allowed
for a remote query.

This parameter is defined through the


DISTRIBUTED DATA FACILITY panel and is
assembled as the RLFERRD parameter of
the DSN6FAC macro.

DDF-THREAD-STATUS The action taken after a DDF thread


successfully commits or rolls back and
holds no database locks or cursors.
The following values are valid:

ACTIVE - Thread remains on the


active thread chain.

INACTIVE - Thread is moved to the


inactive chain.

This parameter is defined via the


"DISTRIBUTED DATA FACILITY" panel and
is assembled as the CMTSTAT parameter
of the DSN6FAC macro.

FACILITY-RESYNC The number of minutes between


resynchronization periods. This value
is the RESYNC in the DB2 Zparms macro
DSN6FAC.

FACILITY-IDLE-THRD-TO The idle thread timeout interval.


This value represents the number of
seconds that an active server thread
is allowed to hold locks and remain
dormant before being cancelled. A
value of 0 indicates server threads
cannot become victim of a timeout.

The idle thread timeout interval is


specified on the "Distributed Data
Facility" installation panel, and is
assembled as the IDTHTOIN parameter of
the DSN6FAC macro.

EXTSEC Indicates whether extended security is


enabled.

Extended security determines content


of the error message returned to a
network client when a DDF connection
request fails due to security errors.
In addition, it indicates whether DDF
will permit an end user to update his
or her RACF password via the DRDA
change password function.

The following values are valid:

YES - Detailed error code returned and


the user can update the RACF
password by DRDA.

NO - Generic error code returned and


the user can not update the RACF
password by DRDA.

The extended security value is


specified on the "Distributed Data
Facility" installation panel, and is
assembled as the EXTSEC parameter of
the DSN6SYSP macro.

TCPIP-VERIFY Shows the TCPIP already verified


value. TCPIP already verified
determines whether TCPIP connection
requests containing only a userid (and
no password, RACF PassTicket, or DCE
ticket) are accepted by DB2. If the
value is YES, TCPIP connection
requests containing only a userid are
accepted.

DB-PROTO-3 The current "protocol used for 3-part


names" value. The value in this field
determines the default protocol (DRDA
or PRIVATE) that is to be used when
option DBPROTOCOL BIND is not
explicitly specified for the bind of a
plan or a package.

An application program might contain


statements with three-part names, or
aliases that reference remote objects.
At bind or rebind of a plan, a user
can specify whether these statements
flow to the remote site using DB2
private protocol or DRDA protocol when
communicating with the remote server.
If bind option DBPROTOCOL is not
specified at bind plan time, then the
default is taken from the value in
field DATABASE PROTOCOL.

The "protocol used for 3-part names"


value is specified on the "Distributed
Data Facility" installation panel, and
is assembled as the DBPROTCL parameter
of the DSN6SYSP macro.

EXTRA-QBLKS-RQSTER The current "max extra requestor query


blocks" value.

The value in this field establishes an


upper limit on the number of extra
DRDA query blocks DB2 requests from a
remote DRDA server. This does not
limit the size of the SQL query answer
set. It simply controls the total
amount of data that can be transmitted
on any given network exchange.

The "max extra requestor query blocks"


value is specified on the "Distributed
Data Facility" installation panel, and
is assembled as the EXTRAREQ parameter
of the DSN6SYSP macro.

EXTRA-QBLKS-SERVER The current "max extra server query


blocks" value.

The value in this field establishes an


upper limit on the number of extra
DRDA query blocks DB2 returns to a
DRDA client. This does not limit the
size of the SQL query answer set. It
simply controls the total amount of
data that can be transmitted on any
given network exchange.

The "max extra server query blocks"


value is specified on the "Distributed
Data Facility" installation panel, and
is assembled as the EXTRASRV parameter
of the DSN6SYSP macro.

T1-MAX-INACTIVE The maximum type 1 inactive threads


allowed by DB2. 0 indicates that type
1 inactive connections are not
allowed.

ZPARM: MAXTYPE1 in DSN6FAC.

TCP-KEEPALIVE Determines whether to override the


TCP/IP stack KeepAlive value. A value
of ENABLE (the default) means do not
override the TCP/IP value. DISABLE
means disable Keep Alive probing all
together. Otherwise, this is a number
(seconds) that indicates that the
TCP/IP stack Keep Alive value should
be modified in favor of this new
value.

The "TCP/IP Keep Alive" value is


specified on the "Distributed Data
Facility" installation panel, and is
assembled as the TCPKPALV parameter of
the DSN6FAC macro.

POOL-THRD-TIMEOUT The current pool thread timeout value.

Pool thread timeout specifies the


time, in seconds, that a DBAT can
remain idle in the pool before it is
terminated. 0 causes a DBAT to
terminate rather than go into the pool
if there is a sufficient number of
threads in the pool to process the
number of type 2 inactive threads that
currently exist.

The pool thread timeout value is


specified on the Distributed Data
Facility installation panel, and is
assembled as the POOLINAC parameter of
the DSN6FAC macro.

SQLINTRP SQL Interrupt processing ENABLEd or


DISABLEd. Typically never changed
except in cases where remote client
systems experience SQL interrupt
oriented failures and a temporary
disablement of the DB2 SQL interrupt
support is required until remote
client systems can be modified to
tolerate the behavior. The default is
ENABLE.

ZPARM name: SQLINTRP in DSN6FAC.

PRGSTRIN Progressive streaming indicator


ENABLEd or DISABLEd. Typically never
changed except in cases where it is
difficult to change client
configuration settings to achieve
desired behavior for progressive
streaming.

Default: ENABLE

AUDITSTART Indicates whether any of the audit


trace classes are automatically
started during initialization. The
destination for these traces will be
SMF.
This parameter is defined through the
TRACING panel and is assembled as the
AUDITST parameter of the DSN6SYSP
macro.

TRACESTART Indicates whether any of the global


trace classes are automatically
started during initialization. The
destination for these traces will be
SMF.

This parameter is defined through the


"TRACING" panel and is assembled as
the TRACSTR parameter of the DSN6SYSP
macro.

TRACTBL The size, in bytes, of the trace table


in which the global trace records DB2
events. Most trace records require
32-byte entries; events with more than
three data items require 64-byte
entries.

This parameter is defined through the


TRACING panel and is assembled as the
TRACTBL parameter of the DSN6SYSP
macro.

ACCOUNTING Indicates whether any of the


accounting trace classes are
automatically started during
initialization. The destination for
these traces will be SMF.

This parameter is defined through the


TRACING panel and is assembled as the
SMFACCT parameter of the DSN6SYSP
macro.

STATISTICS Indicates whether any of the


statistics trace classes are
automatically started during
initialization. The destination for
these traces will be SMF.

This parameter is defined through the


TRACING panel and is assembled as the
SMFSTAT parameter of the DSN6SYSP
macro.

STATIM The time interval, in minutes, between


statistics collections. Statistics
records are written approximately at
the end of this interval.

This parameter is defined through the


TRACING panel and is assembled as the
STATIME parameter of the DSN6SYSP
macro.

MONITORTRACE Indicates whether any of the monitor


trace classes are automatically
started during initialization. The
destination for these traces will be
SMF.

This parameter is defined through the


TRACING panel and is assembled as the
MON parameter of the DSN6SYSP macro.

MONSIZE The default buffer size for a monitor


trace when sending data to monitor
destinations.

This parameter is defined through the


TRACING panel and is assembled as the
MONSIZE parameter of the DSN6SYSP
macro.

PARALLEL-ROLLUP YES or NO. Indicates whether to roll


up query parallel task's accounting
trace into originating task's
accounting trace. If YES, originating
task will cut an additional accounting
trace record with all the roll up
values from parallel tasks. If NO,
each parallel task will produce its
own accounting trace. Default is NO.

The parallel rollup value is not


specified on any installation panel,
but is assembled as the PTASKROL
parameter of the DSN6SYSP macro.

DS-STATS-RESET The current data set stats time


setting.

The value in this field specifies the


time interval, in minutes, between the
resetting of data set statistics for
online performance monitors. Online
performance monitors can request DB2
data set statistics for the current
interval with an IFI READS request for
IFCID 0199.

The data set stats time setting is


specified on the "Tracing and
Checkpoints" installation panel, and
is assembled as the DSSTIME parameter
of the DSN6SYSP macro.

SYNCVAL-SPEC The synchronize stats recording value

This value indicates whether DB2


statistics recording is synchronized
with some part of the hour. You can
specify that the DB2 statistics
recording interval is synchronized
with the beginning of the hour (0
minutes past the hour) or any number
of minutes past the hour up to 59.
If NO (-1) is specified, no
synchronization is done. NO is the
default. This parameter has no effect
if STATIME is greater than 60. For
example, assume you want the DB2
statistics recording interval to have
a length of 15 minutes and to be
synchronized with 15 minutes past the
hour, which means that DB2 statistics
are recorded at 15, 30, 45, and 60
minutes past the hour. To establish
this interval, specify the following:
STATIME=15, SYNCVAL=15.

The synchronize stats recording value


is specified on the "Tracing"
installation panel, and is assembled
as the SYNCVAL parameter of the
DSN6SYSP macro.

ROLLUP-ACCT-DDF-RRSAF Indicates whether to roll up


accounting data by end user for DDF or
RRSAF threads. This value corresponds
to "DDF/RRSAF Accum" on installation
panel DSNTIPN, or ZPARM name: ACCUMACC
in DSN6SYSP.

ROLLUP-ACCT-AGGREGATION Determines the subset of end user


fields by which accounting data is
aggregated. The values are:

0 - End user ID, transaction name,


and workstation name
1 - End user ID
2 - End user transaction name
3 - End user workstation name
4 - End user user ID and transaction
name
5 - End user user ID and workstation
name
6 - End user transaction name and
workstation name

This value is ignored if the value of


ACCUMACC is NO. This value corresponds
to "aggregation fields" on
installation panel DSNTIPN, or ZPARM
name: ACCUMUID in DSN6SYSP.

UIFCIDS Indicates whether IFC trace data will


contain Unicode data. Yes indicates
the records will contain Unicode
fields, where appropriate. In this
case SYSVIEW for DB2 will translate
the fields to EBCDIC. No indicates that
DB2 will translate all fields to
EBCDIC when necessary.

Only a subset of the character fields


(identified in the IFCID record
definition by a U in the comment area
to the right of the field declaration
in the DSNDQWxx copy files) are
encoded in Unicode. The remaining
fields maintain the same encoding of
previous releases.

This parameter is defined through the


"Tracing Parameters" panel and is
assembled as the UFICIDS parameter of
the DSN6SYSP macro.

SMF89 The subsystem parameter SMF89 lets you


specify whether DB2 is to do detailed
tracking for measured usage pricing.
The default value is NO, which means
that DB2 does not do detailed measured
usage tracking. If the SMF type 89
record is activated, only high-level
tracking is recorded in the SMF type
89 record. Selecting NO reduces CPU
usage, but also increases the amount
of time spent in DB2 as measured by
SMF 89. If you select YES, DB2 does
detailed measured usage tracking if
SMF type 89 records are activated.
When SMF89 is set to YES, DB2 invokes
a z/OS service on every entry or exit
into or out of DB2 to ensure accurate
tracking.

Use SMF89 YES only if you use measured


usage pricing.

This parameter is not defined through


any install panel, but is assembled as
the SMF89 parameter of the DSN6SYSP
macro.

ZOSMETRICS Provide z/OS metrics in the IFCID 1


statistics trace record.

ZPARM name: ZOSMETRICS in DSN6SPRM.

GROUP-NAME The name of the DB2 data sharing


group.

This parameter is defined through the


DATA SHARING DEFINE GROUP OR MEMBER
panel and is assembled as the GRPNAME
parameter of the DSN6GRP macro.

DB2-MEMBER-NAME The name of the DB2 data sharing


member.

This parameter is defined through the


DATA SHARING DEFINE GROUP OR MEMBER
panel and is assembled as the MEMBNAME
parameter of the DSN6GRP macro.

DATA-SHARING Indicates whether to use data sharing


The Data Sharing parameter is defined
through the "DATA SHARING FUNCTION"
parameter on the DSNTIPA1 panel.

MAX-MEMBERS The maximum number of data sharing


members.

PARA-COORD Indicates whether this DB2 can be a


parallelism coordinator. If this value
is 'YES', then this DB2 member can
send parallel tasks to eligible DB2
members. If this value is 'NO', then
this DB2 member will not send parallel
tasks to other DB2 members. The
default is 'YES'.

PARA-ASSIST Indicates whether this DB2 can assist


parallel processing. If this value is
'NO', then this DB2 is not considered
as an assistant at either bind time or
run time. If this value is 'YES', then
this DB2 is considered at both bind
time and run time. To be used as an
assistant at run time, this DB2's
VPPSEQT and VPXPSEQT buffer pool
thresholds must be greater than zero.

IMMED-WRITE-OVRRDE Immedwrite override: YES, PH1, or NO.

The IMMEDWRITE value is specified on


the "Application Programming Defaults"
installation panel, and is assembled
as the IMMEDWRI parameter of the
DSN6SPRM macro.

ZPARM-TYPE Online system parameter type.

QWP4OZTM Indicates the time of the last update


of parameters online via the -SET
SYSPARM command.

A value of "2000-01-01 00:00"


indicates that no dynamic updates have
been done.

QWP4OZCI Indicates the correlation ID of the


last user to update the parameters
online via the -SET SYSPARM command.

QWP4OZUS-VAR Indicates the authorization ID of the


last user to update the parameters
online via the -SET SYSPARM command.

EDMPOOL The size of the environmental


descriptor manager (EDM) pool in
bytes.

This parameter is not directly


definable through any installation
panel, but is assembled as the EDMPOOL
parameter of the DSN6SPRM macro.

QWP4SPOL The sort pool size (240KB - 64MB). If


using MVS/ESA 3.1.3 or higher, the
number of sort work files is
unlimited. This parameter can be
updated through "CLIST CALCULATIONS -
PANEL 1" and is assembled as the
SPRMSP parameter of the DSN6SPRM
macro. The number displayed is 4 times
the value entered on the panel.

QWP4RMAX The maximum number of RID blocks in


the DB2 subsystem. The size of each
RID block is 32K (DB2 V8 and above).

This parameter is defined through the


first "CLISTS CALCULATIONS" panel and
is assembled as the MAXRBLK parameter
of the DSN6SPRM macro.

PKG-AUTH-CACHE The size of the package authorization


cache. This field corresponds to the
"Package auth cache" field on
installation panel DSNTIPP.

ZPARM name: CACHEPAC in DSN6SPRM.

DEFAULT-BP-DATA The current default tablespace buffer


pool ID.

The default tablespace buffer pool ID


is specified on the "Buffer Pool
Sizes" installation panel, and is
assembled as the TBSBPOOL parameter of
the DSN6SYSP macro.

DEFAULT-BP8K-DATA Indicates the default 8KB buffer pool


for:

- Table spaces with an 8KB page size


in implicitly created databases.

- Explicitly created table spaces


with an 8KB page size but no
bufferpool clause specified in the
create tablespace statement.

This field corresponds to the "default


8-KB buffer for user data" field on
installation panel DSNTIP1.

DEFAULT-BP16K-DATA Indicates the 16KB buffer pool for:

- Table spaces with an 16KB page size


in implicitly created databases.

- Explicitly created table spaces


with an 16KB page size but no
bufferpool clause specified in the
create tablespace statement.
This field corresponds to the "default
16-KB buffer for user data" field on
installation panel DSNTIP1.

ZPARM name: TBSBP16K in DSN6SYSP.

DEFAULT-BP32K-DATA Indicates the default 32KB buffer pool


for:

- Table spaces with an 32KB page size


in implicitly created databases.

- Explicitly created table spaces


with an 32KB page size but no
bufferpool clause specified in the
create tablespace statement.

This field corresponds to the "default


32-KB buffer for user data" field on
installation panel DSNTIP1.

ZPARM name: TBSBP32K in DSN6SYSP.

DEFAULT-BP-LOB The name of the buffer pool that is


used for implicitly created LOB table
spaces. This field corresponds to the
default buffer pool for user LOB data
on installation panel DSNTIP1.

ZPARM name: TBSBPLOB in DSN6SYSP.

DEFAULT-BP-XML The name of the buffer pool that is


used for XML table spaces. This field
corresponds to the "default buffer
pool for user XML data" field on
installation panel DSNTIP1.

DEFAULT-BP-INDEX The current default index buffer pool


ID.

The default index buffer pool ID is


specified on the "Buffer Pool Sizes"
installation panel, and is assembled
as the IDXBPOOL parameter of the
DSN6SYSP macro.

TABLESPACE-DEFAULT-SPACE The default PRIQTY and SEQCTY values


in KB for table spaces.

INDEXSPACE-DEFAULT-SPACE The default PRIQTY and SEQCTY values


in KB for index spaces.

DSVCI YES indicates that DB2 will create a


DB2-managed data set for a table
space. It will have a VSAM control
interval that corresponds to the
buffer pool used for the table space.

NO indicates that DB2-managed data


sets are to be created with a fixed
control interval of 4-KB, regardless
of the buffer pool size.

This parameter can be updated online.

If you change this value from NO to


YES, any pre-existing or migrated data
sets remain in 4-KB control intervals
until redefined. If you change this
value from YES to NO, any pre-existing
or migrated data sets in 8-KB, 16-KB,
or 32-KB control intervals remain in
those control intervals until
redefined.

You can explicitly redefine a data


set. In addition, data sets are
implicitly redefined by utilities such
as LOAD REPLACE, REORG TABLESPACE, or
RECOVER.

This parameter is defined through


"Sizes Panel 2" and is assembled as
the DSVCI parameter of the DSN6SYSP
macro.

MGEXTSZ Specifies whether secondary extent


allocations for DB2-managed data sets
are to be sized according to a sliding
scale that optimizes the likelihood of
reaching the maximum data set size
before secondary extents are
exhausted.

If NO, the default value, you will


manage secondary extent allocations
manually. If YES, DB2 will
automatically optimize the secondary
extent allocations.

When the sliding scale is used,


secondary extent allocations that are
allocated earlier are smaller than
those allocated later, until a maximum
allocation is reached. The maximum
allocation is 127 cylinders for data
sets with a maximum size of 16 GB or
less, and 559 cylinders for data sets
with a maximum size of 32 GB or 64 GB.

This parameter is defined through


"Sizes Panel 2" and is assembled as
the MGEXTSZ parameter of the DSN6SYSP
macro.

STAR-JOIN-THRESHOLD The minimum number of tables in a


query block before DB2 considers the
query block for star join. Star join
must be enabled before DB2 uses this
system parameter. Values for this
system parameter are:
0: DB2 considers star join
for a query block with 10
or more tables. This is
the default.

1,2,3: DB2 always considers star


join.

4-255: DB2 considers star join if


the query block contains a
minimum of this number of
tables.

226-32767: DB2 does not enable star


join.

This parameter is not defined through


any install panel, but is assembled as
the SJTABLES parameter of the DSN6SPRM
macro.

EDM-DBD-CACHE-SIZE The minimum size of the DBD cache that


is used by EDM in KB.

The storage pool is located above the


2 GB bar.

This parameter is defined through the


"CLIST Calculations" panel, and is
assembled as the EDMDBDC parameter of
the DSN6SPRM macro.

EDM-STMT-CACHE-SIZE The size of the statement cache used


by EDM.

This value is specified in kilobytes.

The storage pool is located above the


2GB bar.

This parameter is defined through the


"CLIST Calculations" panel, and is
assembled as the EDMSTMTC parameter of
the DSN6SPRM macro.

EDM-SKELPOOL-SIZE The minimum size in KB of the EDM pool


for SKCTs and SKPTs. This field
corresponds to field "EDM skeleton
pool size" on installation panel
DSNTIPC.

ZPARM name: EDM_SKELETON_POOL in DSN6SPRM.

XML-AGENT-KB The maximum amount of memory in KB


available for each user for storing
XML values.

XML-SYSTEM-MB The maximum amount of memory in KB


available for storing XML values in
the system.
IMPDSDEF Indicates whether to define the
underlying data sets at the time that
a table space that is in an implicitly
created database is created. This
value corresponds to the "define data
sets" field on installation panel
DSNTIP7.

IMPTSCMP Indicates whether to use data


compression in table spaces in
implicitly defined databases. This
value corresponds to the "use data
compression" field on installation
panel DSNTIP7.

ZPARM name: IMPTSCMP in DSN6SYSP.

MAX-TEMPSTG-AGT-MB The maximum amount of temporary


storage in megabtyes for each agent.
This field corresponds to the "max
temp storage" field on installation
panel DSNTIP9.

ZPARM name: MAXTEMPS.

MAX-DATACACHE-VIRT The maximum amount of virtual memory,


in megabtes, allocated for data
caching. This field corresponds to
field "max data caching" on
installation panel DSNTIP8.

ZPARM name: MXDTCACH in DSN6SPRM.

DEFAULT-DB2-SUBSYS The default DB2 subsystem name to be


used.

DEFAULT-LANGUAGE The default coding language.

PERIOD-COMMA Specifies whether the decimal point


for numbers is the comma (,) or the
period (.).

The decimal point is specified on the


"Application Programming Defaults"
installation panel, and is assembled
as the DECIMAL parameter of the
DSNHDECM macro that builds module
DSNHDECP.

MIN-DIV-SCALE YES indicates that at least three


digits to the right of the decimal
point are retained after any decimal
divide operation.

NO indicates that the usual SQL rules


for decimal division will be used.

DEFAULT-DELIMITER The delimiter default.

DEFAULT-SQL-DELIMITER The SQL string delimiter value.


The SQL string delimiter is specified
on the "Application Programming
Defaults" installation panel, and is
assembled as the SQLDELIparameter of
the DSNHDECM macro that builds module
DSNHDECP.

MIXED-GRAPHICS The mixed data setting controls


whether the code points X'0E' and
X'0F' have special meaning as the
shift-out and shift-in controls for
character strings that include
double-byte characters.

YES indicates that these code points


have special meaning as described
above. Therefore, character strings
can be single-byte character set
(SBCS) or MIXED data.

NO indicates that these code points


have no special meaning. Therefore,
all character strings are SBCS data.

The mixed data value is specified on


the "Application Programming Defaults"
installation panel, and is assembled
as the MIXED parameter of the DSNHDECM
macro that builds module DSNHDECP.

CHARACTER-SET The default character set.

DEFAULT-DATE-FORMAT The date format value. The following


values may be used:

ISO (yyyy-mm-dd)
USA (mm/dd/yyyy)
EUR (dd.mm.yyyy)
JIS (yyyy-mm-dd)
LOCAL installation exit

The date format is specified on the


"Application Programming Defaults"
installation panel, and is assembled
as the DATE parameter of the DSNHDECM
macro that builds module DSNHDECP.

DEFAULT-TIME-FORMAT Indicates the time format value. The


following values may be used:

ISO (hh.mm.ss)
USA (hh:mm AM/PM)
EUR (hh.mm.ss)
JIS (hh:mm:ss)
LOCAL installation exit

The time format is specified on the


"Application Programming Defaults"
installation panel, and is assembled
as the TIME parameter of the DSNHDECM
macro that builds module DSNHDECP.

LOCAL-DATE-LENGTH Indicates the local date length value.

The local date length is specified on


the "Application Programming Defaults"
installation panel, and is assembled
as the DATELEN parameter of the
DSNHDECM macro that builds module
DSNHDECP.

LOCAL-TIME-LENGTH Indicates the local time length value.

The local time length is specified on


the "Application Programming Defaults"
installation panel, and is assembled
as the TIMELEN parameter of the
DSNHDECM macro that builds module
DSNHDECP.

SQL-LANGUAGE-LEVEL Indicates the standard SQL value.

The standard SQL setting controls


whether the SQL language used in
application programs conforms to the
ANSI/ISO SQL standard implemented by
DB2.

86 - programs are written in


accordance with the 1986
ANSI/ISO standard.

YES - programs are written in


accordance with the current
ANSI/ISO standard (beginning
with DB2 version 4).

NO - programs are not written in


accordance with the ANSI/ISO
standards, but are written in
accordance with the SQL
language defined by DB2.

The standard SQL value is specified on


the "Application Programming Defaults"
installation panel, and is assembled
as the STDSQL parameter of the
DSNHDECM macro that builds module
DSNHDECP.

DECIMAL-ARITH Specifies the rules to be used when


both operands in a decimal operation
have precisions of 15 or less.

DEC15 or 15 indicates to use rules


which do not allow a precision greater
than 15 digits.

DEC31 or 31 indicates to use rules


which allow a precision of up to 31
digits.
DB2 always uses the rules of DEC31 if
either operand has a precision greater
than 15.

The decimal arithmetic setting is


specified on the "Application
Programming Defaults" installation
panel, and is assembled as the DECARTH
parameter of the DSNHDECM macro that
builds module DSNHDECP.

DESCSTAT Indicates whether an SQLDA for


describe is built and saved during
bind for staticSQL.

ZPARM name: DESCSTAT in DSN6SPRM.

DECIMAL-ARITH The decimal arithmetic setting


specifies the rules to be used when
both operands in a decimal operation
have precisions of 15 or less.

The decimal arithmetic settings are


as follows:

DEC15 - Use rules which do not allow


a precision greater than 15
digits.

DEC31 - Use rules which allow a


precision of up to 31
digits.

DB2 always uses the rules of DEC31 if


either operand has a precision greater
than 15.

The decimal arithmetic setting is


specified on the "Application
Programming Defaults" installation
panel, and is assembled as the DECARTH
parameter of the DSNHDECM macro that
builds module DSNHDECP.

CACHEDYN Indicates whether DB2 can cache


prepared SQL statements in the EDM
pool.

ZPARM name: CACHEDYN in DSN6SPRM.

CURR-DEG-SPCREG This value is used to set the CURRENT


DEGREE special register when no degree
is explicitly set using the SQL
statement SET CURRENT DEGREE.

The default current degree value is


specified on the "Application
Programming Defaults" installation
panel, and is assembled as the
CDSSRDEF parameter of the DSN6SPRM
macro.

ENSCHEME The encoding scheme value as either


EBCDIC or ASCII.

The encoding scheme is specified on


the "Application Programming Defaults"
installation panel, and is assembled
as the ENSCHEME parameter of the
DSNHDECM macro that builds module
DSNHDECP.

ACCHINTS The current optimizer hints value.


The value in this field allows you to
pass information to DB2 that
influences the access path selected
for certain queries. Information
passed is in the form of rows in the
PLAN_TABLE.

The optimizer hints value is specified


on the "Application Programming
Defaults" installation panel, and is
assembled as the OPTHINTS parameter of
the DSN6SPRM macro.

USE-DECP-DYNAMIC Indicates the "use DECP for Dynamic


Rules" value.

NO indicates that the following


application programming defaults
should be ignored for dynamic SQL
statements when the bind option
DYNAMICRULES(BIND) is in effect:

- Default decimal point


- String delimiter
- SQL string delimiter
- Mixed data
- EBCDIC coded character set
- Decimal arithmetic

YES indicates that the application


programming defaults (in the DSNHDECM
module) for dynamic SQL statements
should be used regardless of the
DYNAMICRULES option in effect.

The "DECP for Dynamic Rules" value is


specified on the "Application
Programming Defaults" installation
panel, and is assembled as the DYNRULS
parameter of the DSNHDECM macro that
builds module DSNHDECP.

DEFAULT-LOCALE Indicates the current default locale


LC_CTYPE value.

Locale LC_CTYPE is a combination of


characters defined for a specific
language and country and a CCSID, for
example, EN_US.IBM-37. The locale
LC_CTYPE is used for language-specific
SQL functions, such as TRANSLATE.

The locale value is specified on the


"Application Programming Defaults"
installation panel, and is assembled
as the LC_CTYPE parameter of the

DSNHDECM macro that builds module


DSNHDECP.

QWP4MDEG The upper limit on the degree of


parallelism.

PARTKEYUP

The update partition key column value.


This value specifies whether values in
columns that participate in
partitioning key may be updated.

YES - Values in columns that


participate in partitioning
keys may be updated. This is
the default.

NO - Values in columns that


participate in
partitioning keys may not
be updated.

SAME - Values in columns that


participate in
partitioning keys may be
updated if and only if
the update leaves the row
belonging to the same
partition.

Attempts to inappropriately update the


value in a partitioning key column
result in the failure of the SQL
statement with a -904 resource
unavailable SQL code. The
accompanying DSNT501I message
identifies the unavailable resource as
code (type X'3000'), and uses reason
code 00C90097.

The update partition key column value


is specified on the "Application
Programming Defaults" installation
panel, and is assembled as the
PARTKEYU parameter of the DSN6SPRM
macro.

NPAGE-THRSHHOLD Indicates the current "favor index


access page threshold" value.

The value indicates that when the


threshold value for the number of
pages (NPAGE catalog column) is less
than the value indicated, the
optimizer will favor index access. A
value of 0 indicates that no special
access path selection is used (DB2
will use the cost factor to determine
access). A value of -1 indicates tells
the optimizer to always favor index
access, regardless of the NPAGE value.

For example, if NPGTHRSH=10 then all


tables with NPAGES [ 10 or with
NPAGES = -1 will tend to favor index
access over tablespace scan.

The "favor index access page


threshold" value is not specified on
any installation panel, but is
assembled as the NPGTHRSH parameter of
the DSN6SPRM macro.

STAR-JOIN-RATIO The implementation of star join:

(-1) - Disable star join. This is the


default.

(0) - Enable star join when the join


meets the conditions in the DB2
Administration Guide.

(1) - Enable star join, with no


checking of the ratio between
the fact table cardinality and
the largest dimension table
cardinality. The table with the
largest cardinality is the fact
table.

(n) - The lowest ratio of the


cardinality of the fact table
to the cardinality of the
largest dimension table for
which star join is used. 2 [ n
[= 32768.

The star join option is not specified


on any installation panel, but is
assembled as the STAR JOIN parameter
of the DSN6SPRM macro.

SMS-DC-DATA-TBLSP The current SMS DATACLASS for


tablespace value.

The DFSMShsm data class that DB2 is to


use when defining (allocating the data
set through Access Method Services
DEFINE) tablespace data sets when
using STOGROUPs. A blank value means
DB2 will not specify a DFSMShsm data
class when defining a data set.
The star SMS DATACLASS for tablespace
value is not specified on any
installation panel, but is assembled
as the SMSDCFL parameter of the
DSN6SPRM macro.

SMS-DC-INDX-TBLSP The current SMS DATACLASS for


indexspace value.

This value specifies the DFSMShsm data


class that DB2 is to use when defining
(allocating the data set through
Access Method Services DEFINE)
indexspace data sets when using
STOGROUPs. A blank value means DB2
will not specify a DFSMShsm data class
when defining a data set.

The star SMS DATACLASS for indexspace


value is not specified on any
installation panel, but is assembled
as the SMSDCIX parameter of the
DSN6SPRM macro.

EDM-BESTFIT The current "use EDM pool better-fit


algorithm" value.

YES - DB2 will use a better-fit


algorithm when searching the
free chain.

NO - DB2 will use a first-fit


algorithm. Is the default
value and only applies when the
EDM pool is greater than 40MB.

The "use EDM pool better-fit


algorithm" value is specified on the
"Application Programming Defaults"
installation panel, and is assembled
as the EDMBFIT parameter of the
DSN6SPRM macro.

APPL-ENCODE-SCHEME The system default application


encoding scheme.

The system default application


encoding scheme affects how DB2
interprets data coming into DB2. For
example, if you set your default
application encoding scheme to 37, and
your EBCDIC coded character set to
500, then DB2 will convert all data
coming into the system to 500 from 37
before using it. This includes, but is
not limited to SQL statement text and
host variables.

The default value, EBCDIC, will cause


DB2 to retain the behavior of previous
releases of DB2 (assume that all data
is in the EBCDIC system CCSID.)

The application encoding scheme is


specified on the "Application
Programming Defaults" installation
panel, and is assembled as the
APPENSCH parameter of the DSNHDECM
macro that builds module DSNHDECP.

EVAL-UNCOMMITTED-OK The "evaluation of uncommitted data


OK" value.

YES means predicate evaluation during


table access can proceed upon
uncommitted data. This applies only to
isolation levels of read stability
(RS) and cursor stability (CS). The
DB2 default is NO.

The "evaluation of uncommitted data


OK" value is specified on the
"Application Programming Defaults"
installation panel, and is assembled
as the EVALUNC parameter of the
DSN6SPRM macro.

MIN-SCALE-DEC-DIV The minimum scale for the result of a


decimal division.

The values for this parameter are none


(the default), 3, or 6. If 3 or 6 is
specified, this parameter overrides
the DECDIV3 parameter.

This parameter is not defined through


any install panel, but is assembled as
the MINDVSCL parameter of the DSN6SPRM
macro.

NEWFUN Indicates whether or not DB2 is


running in new function mode.

This parameter is defined through the


"Main Panel" panel and is assembled as
the NEWFUN parameter of the DSNHDECP
macro.

PADNTSTR Specifies whether output host


variables that are null-terminated
strings are padded with blanks and a
null-terminator.

If NO is specified, null-terminated
output host variables have the
null-terminator placed at the end of
actual data that is returned in the
host variable.

If YES is specified, null-terminated


output host variables have the
null-terminator placed at the end of
the string, after the string has been
padded with blanks from the end of the
actual data to the length of the
output host variable.

This parameter is defined through the


"Application Programming Defaults 2"
panel and is assembled as the PADNTSTR
parameter of the DSNHDECP macro.

DB2SUPLD Indicates whether the DSNHDECP module


is the DB2 supplied (YES) module or a
customer generated one (NO).

DECFLOAT-ROUNDING-MODE The default rounding mode for the


decimal floating point type.

HSM-RECALL Shows whether DFHSM automatic recall


is performed for DB2 databases.

YES indicates that DFHSM is invoked to


recall it automatically.

NO indicates that a DB2 table space


that has been migrated is considered
to be an unavailable resource. It must
be recalled explicitly before it can
be used by DB2.

This parameter is defined through the


"OPERATOR FUNCTIONS" panel and is
assembled as the RECALL parameter of
the DSN6SPRM macro.

HSM-RECALL-DELAY Indicates the maximum length of time


in seconds that a program can be
delayed for a DFHSM recall. If the
recall is not completed within the
specified number of seconds, the
program receives an error message
indicating that the pageset is
unavailable, but that recall was
initiated. If this value is 0 and the
RECALL parameter is YES, then the
recall is processed asynchronously.

Note that the recall delay option is


not used when running a DB2 utility
against a DB2 migrated data set.

This parameter is defined through the


"OPERATOR FUNCTIONS" panel and is
assembled as the RECALLD parameter of
the DSN6SPRM macro.

AUTOBND Specifies whether or not a plan or


package can go thru autobind.

ENABLED means DB2 can perform an


autobind.
DISABLED means that a user must
explicitly rebind any invalid plan or
package to make it operational.

COEXIST indicates that remigration


automatic rebind is disabled while all
other automatic rebinding is enabled.

This parameter is defined through the


"OPERATOR FUNCTIONS" panel and is
assembled as the ABIND parameter of
the DSN6SPRM macro.

AUTOBIND-EXPLAIN Indicates whether or not EXPLAIN


processing occurs during autobind.

The EXPLAIN parameter is defined


through the "OPERATOR FUNCTIONS" panel
and is assembled as the SPRMABX
parameter of the DSN6SPRM macro.

CHG-DATA-CAPTURE Specifies whether or not change data


capture is enabled.

The change data capture parameter is


defined through the "OPERATOR
FUNCTIONS" panel and is assembled as
the CHGDC parameter of the DSN6SPRM
macro.

DATA-PROP-ONLY Indicates whether or not you have a


"2" for the "DPROP SUPPORT" parameter
on the "OPERATOR FUNCTIONS" panel.
This means that using DPROP to
propagate with DATA CAPTURE CHANGES is
ONLY allowed when the following
conditions are met:

Monitor trace class 6 is active.


Dprop is installed. The DB2
application is running in an IMS
environment.

If any one of these conditions is not


met, no changes to the DB2 table are
allowed.

The Dprop only parameter is assembled


as the CHGDC parameter of the DSN6SPRM
macro.

SITETYPE Shows whether the current system is at


the local site or a recovery site.

LOCAL is defined as the site where the


multiple image copies are made and are
operational.

RECOVERY is defined as the site named


as an alternative for recovery
purposes.

The RECOVER utility looks at this


parameter to determine what site the
current system is on and recovers
everything from the copies of data
registered at that site.

This parameter is defined through the


"OPERATOR FUNCTIONS" panel and is
assembled as the SITETYP parameter of
the DSN6SYSP macro.

TRACKER-SITE Indicates whether this DB2 is a


tracker site.

The tracker site value is defined


through the "OPERATOR FUNCTIONS" panel
and is assembled as the TRKRSITE
parameter of the DSN6SPRM macro.

VARCHAR-RETR-INDEX Indicates YES or NO.

YES indicates data retrieval from


index key is allowed for varying
length columns. The default is NO.

The retrieve variable column from


index value is not specified on any
installation panel, but is assembled
as the RETVLCFK parameter of the
DSN6SPRM macro.

OUTER-JOIN-ENHANCE Indicates whether or not outer join


performance enhancements are enabled.
The default is NO.

The outer join enhancements value is


not defined through any installation
panel, but is assembled as the
OJPERFEH parameter of the DSN6SPRM
macro.

SUPR-LOGREC-SOFT Indicates the "suppress soft errors


from logrec" value.

This value specifies whether or not


DB2 will suppress LOGREC recording of
recoverable RDS abends (soft errors).

The "suppress soft errors from logrec"


value is specified on the "MVS Parmlib
Updates" install panel, and is
assembled as the SUPERRS parameter of
the DSN6SPRM macro.

SKIPUNCI Specifies whether cursors bound with


read stability or cursor stability
will ignore uncommitted inserts made
by other transactions.
If NO, the default value, uncommitted
inserts are evaluated for return with
or without waiting for committedness
according to the value that is set in
the EVALUATE UNCOMMITTED field.

If YES, uncommitted inserts will be


treated as if they had not yet
arrived. In a data sharing
environment, uncommitted inserts of
transactions that were designated as
spawning transactions will be treated
in this manner. Immediate write occurs
for inserts, updates, and deletes,but
readers do not wait for the outcome of
uncommitted inserts.

This parameter is defined through the


"Performance and Optimization" panel
and is assembled as the SKIPUNCI
parameter of the DSN6SPRM macro.

DISABSCL Allows you to choose whether SQLWARN1


and SQLWARN5 set for non-scrollable
cursors on OPEN and ALLOCATE CURSOR.

This parameter is not defined through


any install panel, but is assembled as
the DISABSCL parameter of the DSN6SPRM
macro.

RTS-STATS-INTERVAL The time interval that DB2 waits


before it attempts to write out page
set statistics to the real-time
statistics tables.

This parameter is defined through the


"Operator Functions" panel and is
assembled as the STATSINT parameter of
the DSN6SPRM macro.

INLISTP The maximum number of elements in an


in-list for an in-list predicate to be
optimized. If the in-list contains
this number or fewer elements, the
in-list is optimized in the following
ways:

The in-list predicate is pushed down


into a materialized view or table
expression.

A correlated in-list predicate in a


subquery that is generated by
transitive closure can be moved up to
the parent query block.

This value can be between 0 and 5000.


0 means that no optimization occurs.
The default is 50.
This parameter is not defined through
any install panel, but is assembled as
the INLISTP parameter of the DSN6SPRM
macro.

REFRESH-VALUE The default value for the CURRENT


REFRESH AGE special register when no
value is explicitly set using the SQL
statement SET CURRENT REFRESH AGE. A
value of 0 disables query rewrite
using deferred materialized query
tables.

This parameter is defined through the


"Performance and Optimization" panel,
and is assembled as the REFSHAGE
parameter of the DSN6SPRM macro.

MAINTAINED-TBL-TYPE The default for the current maintained


table types for optimization special
register.

ZPARM name: MAINTYPE in DSN6SPRM.

PLANMGMT The default value for the REBIND


PLANMGMT parameter.

REOPTEXT Indicates whether or not to reoptimize


dynamic SQL automatically. This field
corresponds to field "reopt
automatically" on installation panel
DSNTIP8.

ZPARM name: REOPTEXT.

ADMIN-PROC-NAME Indicates the Admin Scheduler JCL proc


name.

RLFSTART Shows whether or not the resource


limit facility (governor) is
automatically started each time DB2 is
started.

YES indicates that it is to be


automatically started.

NO indicates that it is not.

This parameter is defined through the


"OPERATOR FUNCTIONS" panel and is
assembled as the RLF parameter of the
DSN6SYSP macro.

RLFTBL The suffix of the default resource


limit specification table (RLST). The
default RLST is used when the resource
limit facility (RLF) is automatically
started, or when you start RLF without
specifying a suffix.

This parameter is defined through the


"OPERATOR FUNCTIONS" panel and is
assembled as the RLFTBL parameter of
the DSN6SYSP macro.

RLFAUTH-VAR The authorization ID used to qualify


the resource limit tables.

This parameter is defined through the


"PROTECTION" panel and is assembled as
the RLFAUTH parameter of the DSN6SYSP
macro.

ROUTE-CODE-LIST The MVS console routing codes assigned


to messages that are not solicited
from a specific console.

This parameter is defined through the


"OPERATOR FUNCTIONS" panel and is
assembled as the ROUTCDE parameter of
the DSN6SYSP macro.

DECP-DSNAME The fully qualified name of the data


set from which the DSNHDECP module was
loaded.

DB-START-DFER Listed when DB2 itself is started.

STARTED - The specified databases and


page sets should be
automatically started.

DEFERRED - The specified databases and


page sets should be
deferred.

This parameter is defined through the


"DATABASES AND SPACES TO START
AUTOMATICALLY" panel and is assembled
as the RESTART and ALL parameters of
the DSN6SPRM macro.

DB-LIST-1 The name of a database or space to be


started or deferred, or "ALL" if all
databases or spaces are to started or
deferred.

This parameter is defined through the


"DATABASES AND SPACES TO START
AUTOMATICALLY" panel and is assembled
as the ALL parameter of the DSN6SPRM
macro.

SYSADM-VAR The first of two authorization IDs


with installation SYSADM authority.

The two users with installation SYSADM


authority are permitted access to DB2
in all cases. However, the
authorization ID named as the first
system administrator is capable of
doing several more things than the
authorization ID named as the second
system administrator, such as running
job DSNTIJTC and the REPAIR DBD
utility.

This parameter is defined through the


"PROTECTION" panel and is assembled as
the SYSADM parameter of the DSN6SPRM
macro.

SYSADM2-VAR The second of two authorization IDs


with installation SYSADM authority.
The two users with installation SYSADM
authority are permitted access to DB2
in all cases. However, the
authorization ID named as the first
system administrator is capable of
doing several more things than the
authorization ID named as the second
system administrator, such as running
job DSNTIJTC and the REPAIR DBD
utility.

This parameter is defined through the


"PROTECTION" panel and is assembled as
the SYSADM2 parameter of the DSN6SPRM
macro.

SYSOPR1-VAR The first of two authorization IDs


with installation SYSOPR authority.
The two users with installation SYSOPR
authority are permitted access to DB2
even if the DB2 catalog is
unavailable.

This parameter is defined through the


"PROTECTION" panel and is assembled as
the SYSOPR1 parameter of the DSN6SPRM
macro.

SYSOPR2-VAR The second of two authorization IDs


with installation SYSOPR authority.
The two users with installation SYSOPR
authority are permitted access to DB2
even if the DB2 catalog is
unavailable.

This parameter is defined through the


"PROTECTION" panel and is assembled as
the SYSOPR2 parameter of the DSN6SPRM
macro.

DEFLTID-VAR The authorization ID used if an ID is


not available for batch access and
USER= is not specified in the job
statement.

This parameter is defined through the


"PROTECTION" panel and is assembled as
the DEFLTID parameter of the DSN6SPRM
macro.
GRANTREV Shows whether or not the SQL
statements GRANT and REVOKE are to be
effective.

DISABLED implies all authorization


checking in DB2 is disabled and the
GRANT statement is invalid (granting
every privilege to PUBLIC). DISABLES
is not recommended.

This parameter is defined through the


"PROTECTION" panel and is assembled as
the AUTH parameter of the DSN6SPRM
macro.

BIND-NEW-PACKAGE The current authorization required for


binding new packages.

BINDADD implies that the BINDADD


system privilege is required to create
a new package or a new version of a
package. Otherwise, BIND implies that
only the BIND privilege is needed on a
package or collection to create a new
version of an existing package when a
bind is performed.

The bind new package authorization is


specified on the "Protect"
installation panel, and is assembled
as the BINDNV parameter of the
DSN6SPRM macro.

DBA-CREATE-VIEWS Shows the "DBADM create view for


others" setting.

This setting controls whether an


authorization ID with DBADM authority
can create a view for another
authorization ID. It also specifies
whether an authorization ID with
DBCTRL or DBADM authority, on the
database of the table for which an
alias is being created, can create an
alias for itself or another
authorization ID.

The "DBADM create view for others"


value is specified on the "Protect"
installation panel, and is assembled
as the DBACRVW parameter of the
DSN6SPRM macro.

AEXITLIM The access control authorization exit


abend count.

IRLMPROC The name if the IRLM procedure that


DB2 starts if IRLMAUT=YES.

This parameter is defined through the


"IRLM PANEL 1" panel and is assembled
as the IRLMPRC parameter of the
DSN6SPRM macro.

IRLMSID The name by which MVS knows the IRLM


subsystem. The name is used for
communication between DB2 and the
IRLM. This name is included in the MVS
subsystem table IEFSSNxx.

This parameter is defined through the


"IRLM PANEL 1" panel and is assembled
as the IRLMSID parameter of the
DSN6SPRM macro. This value is also
specified in the IRLMNM parameter of
the IRLM start-up JCL.

IRLMRWT The number of seconds IRLM waits


before detecting a time-out.

Time-out means that a lock request has


waited for a resource longer than the
number of seconds identified in this
field. The value specified for this
option must be an integer multiple of
the deadlock time specified through
the DEADLOK parameter in the IRLM
start-up JCL because IRLM uses its
deadlock timer to initiate time-out
detection, as well as deadlock
detection.

This parameter is defined through the


"IRLM PANEL 1" panel and is assembled
as the IRLMRWT parameter of the
DSN6SPRM macro.

IRLMSWT The time, in seconds, that DB2 waits


for IRLM to start during autostart. If
the time expires, DB2 abends.

This parameter is defined through the


"IRLM PANEL 1" panel and is assembled
as the IRLMSWT parameter of the
DSN6SPRM macro.

IRLMSTART Shows whether or not DB2 automatically


starts and stops the IRLM.

YES means that when DB2 starts, it


tries to start the IRLM if the IRLM is
not already started. When DB2 stops,
it automatically stops the IRLM.

NO means that DB2 terminates if the


IRLM is not already active when DB2 is
started.

This parameter is defined through the


"IRLM PANEL 1" panel and is assembled
as the IRLMAUT parameter of the
DSN6SPRM macro.

IMSBMP-TO-FACTOR The number of timeout cycles that an


IMS BMP region will wait for a lock as
specified at DB2 start-up. A value of
zero indicates to use the DB2 default.

The IMS BMP timeout factor is not


specified on any installation
panel,but may be specified in the
DSN6SPRM macro as the BMPTOUT
parameter.

IMSDLI-TO-FACTOR The number of timeout cycles that an


IMS DLI region will wait for a lock as
specified at DB2 start-up. A value of
zero indicates to use the DB2 default.

The IMS DLI timeout factor is not


specified on any installation panel,
but may be specified in the DSN6SPRM
macro as the DLITOUT parameter.

USE-RRU-LOCK Indicates whether or not to use the


Update lock when using Repeatable Read
to access a table.

This parameter is defined through the


Installation parameter "USE U LOCK FOR
RR" on the "DSNTIPI" panel and is
assembled as the RRULOCK parameter of
the DSN6SPRM macro.

XLOCK-SEARCH-UPDTE The locking method used when


performing a searched update or
delete. The default is NO, meaning an
S or U lock when scanning for
qualifying rows. YES means use an X
lock.

The searched update/delete lock is not


defined through any installation
panel, but is assembled as the
XLKUPDLT parameter of the DSN6SPRM
macro.

QWP4WAIT Indicates the current "wait


incompatible retained lock" value.

If enabled, IRLM lock or change


requests will wait for incompatible
retained locks. If disabled, IRLM
lock or change requests will not wait
for incompatible retained locks, but
instead will be immediately rejected.

This is a numerical value which is


used as a multiplier to the
connection's normal timeout interval
to determine how long the application
will wait for an incompatible lock. A
value of 0 indicates that there will
be no wait.

The "wait incompatible retained lock"


value is not specified on any
installation panel, but it is
assembled as the RETLWAIT parameter of
the DSN6SPRM macro.

IRLM-SUBSYS Shows the name by which MVS knows the


IRLM subsystem. The name is used for
communication between DB2 and the
IRLM. This name is included in the MVS
subsystem table IEFSSNxx.

This parameter is defined through the


"IRLM PANEL 1" panel and is assembled
as the IRLMSID parameter of the
DSN6SPRM macro. This value is also
specified in the IRLMNM parameter of
the IRLM start-up JCL.

IRLM-ID Shows the unique number assigned to


the IRLM for internally distinguishing
this IRLM from other IRLMs that are
sharing data.

This value is specified in the IRLMID


parameter of the IRLM start-up JCL.

IRLM-MODE Shows whether the IRLM is processing


in LOCAL or GLOBAL mode.

In GLOBAL mode, the IRLM can


communicate with other IRLM subsystems
for data sharing. In LOCAL mode, no
data sharing is allowed, but the
overhead costs of IRLM are reduced.

This value is specified in the SCOPE


parameter of the IRLM startup JCL.

IRLM-COMM-CYCLE The number of milliseconds that IRLM


delays between each lock processing.
IRLM uses this interval for IMS data
sharing. IRLM batches the inter-IRLM
requests, and once every interval it
sends the requests to the other IRLM
for approval.

This parameter is valid only if


SCOPE=GLOBAL is also specified.

This value is specified in the COMCYCL


parameter of the IRLM start-up JCL.

IRLM-TRACE Shows whether or not the IRLM internal


trace is to be automatically started
when the IRLM is started.

This value is specified in the ITRACE


parameter of the IRLM start-up JCL.

IRLM-PCPT Shows whether IRLM is to use the


cross-address-space program call.

NO indicates that IRLM control block


structures (locks) are kept in the
ECSA (ex tended common storage area).
This requires less processor time at
the cost of using common storage.

YES indicates that the IRLM control


block structures are kept in the IRLM
private address space, and the PC
(program call) instruction is used to
obtain addressability to the
structures.

This value is specified in the PC


parameter of the IRLM start-up JCL.

IRLM-MAX-CSA The maximum amount of ECSA (extended


common storage area) that IRLM is to
use for its control block structure
(locks).

This value is specified in the MAXCSA


parameter of the IRLM start-up JCL.

IRLM-DEADLOCK-TIME The time, in milliseconds, of the


local deadlock detection cycle.

The local value must be less than the


value specified for the resource
timeout zparm value (IRLMRWT).
Otherwise, time-out detection will
always supersede deadlock detection.

A deadlock is a situation where two or


more requestors are waiting for
resources held by the other. Deadlock
detection is the procedure by which a
deadlock and its participants are
identified. IBM recommends that this
value not exceed 5000.

IRLM-DEADLOCK-CYCLES The number of local cycles per global


cycle.

IRLM-TIMEOUT-INT The timeout interval.

IRLM-HASH-ENTRIES The number of z/OS lock table hash


entries.

IRLM-PEND-HASH-ENTRIES The pending number of hash entries.

IRLM-LIST-ENTRIES The number of z/OS lock table list


entries.

STORPROC-ALLOW-ABNDS The stored procedure maximum abend


count value.
This value specifies the number of
times a stored procedure is allowed to
terminate abnormally, after which SQL
CALL statements for the stored
procedure are rejected.

A value of 0 means that the first


abend of a stored procedure causes SQL
CALLs to that procedure to be
rejected.

The stored procedure maximum abend


count is specified on the "Stored
Procedures Parameters" installation
panel, and is assembled as the
STORMXAB parameter of the DSN6SYSP
macro.

STORPROC-TIMEOUT The stored procedure timeout value.

This value specifies the number of


seconds before DB2 ceases to wait for
an SQL CALL to be assigned to one of
the task control blocks (TCBs) in the
DB2 stored procedures address space.
If the time interval expires, the SQL
statement fails.

The stored procedure timeout value is


specified on the "Stored Procedures
Parameters" installation panel, and is
assembled as the STORTIME parameter of
the DSN6SYSP macro.

DEFAULT-WLM-ENVIRON The current WLM environment name.

The value in this field specifies the


name of the WLM_ENVIRONMENT to use for
a user-defined function or stored
procedure when a value is not given
for the WLM_ENVIRONMENT option on
statements CREATE FUNCTION or CREATE
PROCEDURE.

The WLM environment name is specified


on the "Routine Parameters"
installation panel, and is assembled
as the WLMENV parameter of the
DSN6SYSP macro.

IQL name: DEFAULT-WLM-ENVIRON

QWP4RAC The amount of storage allocated to the


caching of authorization information
for all routines on this DB2
subsystem.

The default is 32k. This parameter


corresponds to field "Routine auth
cache" on installation panel DSNTIPP.
MAX-CURSORS-PER-THD The maximum number of cursors,
including allocated cursors, that are
open at a given DB2 site per thread.

RDS will keep a total of currently


open cursors. If an application
attempts to open a thread after the
maximum is reached, the statement will
fail.

This field corresponds to field "max


open cursors" on the installation
panel.

This parameter is defined through the


"Routine Parameters" panel, and is
assembled as the MAX_NUM_CUR parameter
of the DSN6SPRM macro.

MAX-STPROC-PER-THD The maximum number of stored


procedures per thread.

If an application attempts to call a


stored procedure after the maximum is
reached, the statement will fail.

This field corresponds to the "Max


stored procs" field on the
installation panel.

This parameter is defined through the


"Routine Parameters" panel, and is
assembled as the MAX_ST_PROC parameter
of the DSN6SPRM macro.

DDCS-INSTALLED Indicates whether or not the DDL


registration facility is enabled.

The enabling parameter is defined


through the "DATA DEFINITION CONTROL
SUPPORT" panel and is assembled as the
RGFINSTL parameter of the DSN6SPRM
macro.

DDCS-ALLAPPLS Indicates whether or not only


registered packages or plans can use
DDL.

The registration requirement parameter


is defined through the "DATA
DEFINITION CONTROL SUPPORT" panel and
is assembled as the RGFDEDPL parameter
of the DSN6SPRM macro.

DDCS-FULLNAMES Indicates whether or not two-part


names are required for every
objectregistered in ORT.

The fully qualified names parameter is


defined through the "DATA DEFINITION
CONTROL SUPPORT" panel and is
assembled as the RGFFULLQ parameter of
the DSN6SPRM macro.

DDCS-UNREGSTRD-DEFAULT Indicates the action taken for DDL


that names an unregistered object:

ACCEPT - Accept the DDL.

REJECT - Reject the DDL.

APPL - The DDL is rejected if the


application is not
registered.

The unregistered DDL default parameter


is defined through the "DATA
DEFINITION CONTROL SUPPORT" panel and
is assembled as the RGFDEFLT parameter
of the DSN6SPRM macro.

DDL-ESCAPE-CHAR The DDCS escape character for


application and owner registration
table search.

This parameter is defined through the


"DATA DEFINITION CONTROL SUPPORT"
panel and is assembled as the RGFESCP
parameter of the DSN6SPRM macro.

DDL-REGISTRATN-DATABASE The name of the database that contains


the registration tables.

This parameter is defined through the


"DATA DEFINITION CONTROL SUPPORT"
panel and is assembled as the RGFDBNAM
parameter of the DSN6SPRM macro.

DDL-REG-OWNER-VAR The owner of the application


registration table and the object
registration table.

This parameter is defined through the


"DATA DEFINITION CONTROL SUPPORT"
panel and is assembled as the RGFCOLID
parameter of the DSN6SPRM macro.

DDL-REG-ART-VAR The name of the application


registration table.

This parameter is defined through the


"DATA DEFINITION CONTROL SUPPORT"
panel and is assembled as the RGFNMPRT
parameter of the DSN6SPRM macro.

DDL-REG-ORT-VAR The name of the object registration


table.

This parameter is defined through the


"DATA DEFINITION CONTROL SUPPORT"
panel and is assembled as the RGFNMORT
parameter of the DSN6SPRM macro.

RESTART-BACKOUT Specifies whether DB2 postpones some


backward log processing during
restart. It applies to the non-data
sharing environment only. This field
corresponds to the "limit backout"
field on installation panel DSNTIPN.

ZPARM name: LBACKOUT in DSN6SYSP.

RESTART-BACKOUT-LIMIT The value that, when multiplied by the


value in field QWP1URCK, gives the
number of log records processed during
backward log processing when the value
of QWP1LMBO is "YES" or "AUTO." This
field applies to the non-data sharing
environment only.

This field corresponds to field


"backout duration" on installation
panel DSNTIPN.

SEQPRES Indicates whether to use the


sequential prestage function of 3990
sequential cac ing for utilities. This
parameter corresponds to the "utility
cache option" field on installation
panel DSNTIPE.

ZPARM name: SEQPRES in DSN6SPRM.

STATS-HISTORY The "collect catalog stats history"


value.

This value specifies which inserts and


updates are recorded in catalog
history tables. When the SPACE option
is specified, all inserts and updates
made by DB2 space related catalog
statistics are recorded. Valid values
are:

ACCESSPATH - All inserts and updates


made by DB2 to
ACCESSPATH related
catalog statistics are
recorded.

ALL - All inserts and updates


made by DB2 in the
catalog are recorded.

NONE - Changes made in the


catalog by DB2 are not
recorded. This is the
default.

The "collect catalog stats history"


value is specified on the "Operator
Functions" install panel, and is
assembled as the STATHIST parameter of
the DSN6SPRM macro.

STATS-ROLLUP Indicates the statistics roll-up


default.

Specifies whether the RUNSTATS utility


will aggregate the partition level
statistics. Valid values are YES or
NO.

The statistics roll-up value is


specified on the "Operator Functions"
install panel, and is assembled as the
STATROLL parameter of the DSN6SPRM
macro.

UTILITY-TIMEOUT Indicates the number of timeout


intervals that a utility will wait for
a held resource. This allows
utilities to wait longer than normal
SQL.

This parameter is defined through the


"IRLM PANEL 2" panel and is assembled
as the UTIMOUT parameter of the
DSN6SPRM macro.

TEMP-DS-DEVICE-TYPE Specifies the device type or unit name


for allocating temporary data sets. It
is the direct access or disk unit name
that is used for the precompiler,
compiler, assembler, sort, linkage
editor, and utility work files in the
tailored jobs and CLISTs.

DB2 utilities that dynamically


allocate temporary data sets also use
this parameter. This field corresponds
to the "temporary unit name" field on
the install panel.

This parameter is defined through the


"Data Parameters" panel, and is
assembled as the VOLTDEVT parameter of
the DSN6SPRM macro.

UTSORTAL The utility sortwork allocation. Valid


values are YES or NO. YES indicates
that utilities will use SORTNUM
elimination logic for sort tasks. The
default is NO.

ZPARM name: UTSORTAL in DSN6SPRM.

IGNSORTN Indicates whether to ignore the


SORTNUM keyword.

Valid settings are YES or NO. The


default is NO.
YES, valid only when the UTSORTAL
ZPARM is also YES, indicates that
every SORTNUM keyword specification in
a DB2 utilities control statement will
be ignored.

ZPARM name: IGNSORTN in DSN6SPRM.

SYSTEM-LEVEL-BACKUPS Indicates whether or not recover uses


system level backups as the recovery
base. This field corresponds to the
system-level backups field on
installation panel.

ZPARM name: SYSTEM_LEVEL_BACKUPS.

RESTORE-RECOVER-FROMDUMP Indicates whether system-level backup


that is the recovery base is from a
dump on tape. This field corresponds
to the "restore/recover" field on
installation panel DSNTIP6.

ZPARM name: RESTORE_RECOVER_FROMDUMP.

UTIL-RSTSYS-DMP-CL The name of the DFSMSHSM dump class


used by the restore system utility to
restore from a system-level backup
that has been dumped to type.

This field corresponds to field "dump


class name" on installation panel
DSNTIP6.

UTIL-RSTSYS-MAX-TP The maximum number of tape units or


tape drives that the restore system
utility can use to restore from a
system-level backup that has been
dumped to tape.

This field corresponds to the "maximum


tape units" field on installation
panel D TIP6.

STATCLUS Indicates whether or not RUNSTATS uses


enhanced clustering statistics.

This field corresponds to field


"statistics clustering" on
installation panel DSNTIP6.

ZPARM name: STATCLUS in DSN6SPRM.

HONOR-KEEPDICT Specifies whether DB2 should honor or


ignore the KEEPDICTIONARY parameter on
a LOAD REPLACE or REORG request that
converts a table space from basic row
format to reordered row format.

Valid settings are YES and NO.

ZPARM name: HONOR_KEEPDICTIONARY in


DSN6SPRM.

LOGLOAD The number of minutes between


checkpoints, if the value is between 1
and 60. Otherwise, the value
represents the number of log records
to be written between checkpoints.

The checkpoint frequency is specified


on the "Active Log Data Set
Parameters" installation panel, and is
assembled as the CHKFREQ parameter of
the DSN6SYSP macro.

LOGPARM Indicates whether single or dual


active logging is enabled.

This parameter is defined through the


"SYSTEM RESOURCE DATA SET NAMES" panel
and is assembled as the TWOACTV
parameter of the DSN6LOGP macro.

OUTBUFF The size of the output buffer used for


writing active and archive log data
sets.

This parameter is defined through the


"ACTIVE LOG DATA SET PARAMETERS" panel
and is assembled as the OUTBUFF
parameter of the DSN6LOGP macro.

WRTHRSH The number of buffers DB2 will fill


before issuing a write.

This parameter is defined through the


"ACTIVE LOG DATA SET PARAMETERS" panel
and is assembled as the WRTHRSH
parameter of the DSN6LOGP macro.

This parameter has become a constant


with a value of 20. It is still
assembled as the WRTHRSH parameter of
the DSN6LOGP macro.

ARCRETN Indicates the number of days that DB2


is to retain archive log data sets.

The retention period is used in MSS


and tape management systems to control
the r use and scratching of data sets
and tapes. DB2 uses this value as the
value for the JCL parameter RETPD when
archive log data sets are created.

The retention period is added to the


current date to calculate the
expiration date. If a value for the
retention period causes the expiration
date to exceed 99365, the expiration
date is set to 99365.
This parameter is defined through the
"ARCHIVE LOG DATA SET PARAMETERS"
panel and is assembled as the ARCRETN
parameter of the DSN6ARVP macro.

BSDSPARM Indicates whether single or dual BSDS


is used.

This parameter is not directly


definable through any installation
panel, but is assembled as the TWOBSDS
parameter of the DSN6LOGP macro.

MAXARCH Indicates the maximum number of


archive log volumes to be recorded in
the BSDS.

When this number is exceeded,


recording resumes at the beginning of
the BSDS.

Create image copies of all DB2


objects, preferably several times,
before the archive log data set is
discarded (that is, the number of
entries in the BSDS has wrapped).

If you fail to retain an adequate


number of archive log data sets for
all the image copies needed, you might
have to cold start or reinstall DB2.

This parameter is defined through the


"ARCHIVE LOG DATA SET PARAMETERS"
panel and is assembled as the MAXARCH
parameter of the DSN6LOGP macro.

ARCHPARM Indicates whether single or dual


archiving is enabled.

This parameter is defined through the


"SYSTEM RESOURCE DATA SET NAMES" panel
and is assembled as the TWOARCH
parameter of the DSN6LOGP macro.

ARCHPFX1 The data set name prefix that DB2 will


use when creating the first archive
copy of the active log.

This parameter is defined through the


"SYSTEM RESOURCE DATA SET NAMES" panel
and is assembled as the ARCPFX1
parameter of the DSN6ARVP macro.

ARCHPFX2 The data set name prefix that DB2 will


use when creating the second archive
copy of the active log.

This parameter is defined through the


"SYSTEM RESOURCE DATA SET NAMES" panel
and is assembled as the ARCPFX2
parameter of the DSN6ARVP macro.

ARCH-EXT-DATESTAMP Indicates whether or not to timestamp


the archive in extended (4 digit year)
format.

The timestamp parameter is not


directly definable through any
installation panel, but is assembled
as the TSTAMP parameter of the
DSN6ARVP macro.

CPY21ST Shows the current "read archive copy 2


first" value.

The value in this field indicates


whether COPY2 archives should be read
first.

The "read archive copy 2 first" value


is specified on the "Operator
Functions" installation panel, and is
assembled as the ARC2FRST parameter of
the DSN6LOGP macro.

UNIT The device type or unit name for


storing archive log data sets.

This parameter is defined through the


"ARCHIVE LOG DATA SET PARAMETERS"
panel and is assembled as the UNIT
parameter of the DSN6ARVP macro.

ARCH-ALLOC-UNIT Indicates whether the archive log is


allocated in cylinders, tracks or
blocks.

The allocation unit parameter is


defined through the "ARCHIVE LOG DATA
SET PARAMETERS" panel and is assembled
as the ALCUNIT parameter of the
DSN6ARVP macro.

ARC-PRI-ALLOC The primary space allocation for a


DASD data set, in units of ALCUNIT.

This parameter is defined through the


"ARCHIVE LOG DATA SET PARAMETERS"
panel and is assembled as the PRIQTY
parameter of the DSN6ARVP macro.

ARC-SEC-ALLOC The secondary space allocation for a


DASD data set, in units of ALCUNIT.

This parameter is defined through the


"ARCHIVE LOG DATA SET PARAMETERS"
panel and is assembled as the SECQTY
parameter of the DSN6ARVP macro.

BLOCK-SIZE The block size of the archive log data


set.
This parameter is defined through the
"ARCHIVE LOG DATA SET PARAMETERS"
panel and is assembled as the BLKSIZE
parameter of the DSN6ARVP macro.

DEVTYPE The current archive log device type or


unit name to use with the second
archive copy data set.

The device type 2 or unit 2 name is


specified on the "Archive Log Data Set
Parameters" installation panel, and is
assembled as the UNIT2 parameter of
the DSN6ARVP macro.

MSVGP The mass storage volume group to be


used for the first copy of archive log
data sets.

This parameter is defined through the


"ARCHIVE LOG DATA SET PARAMETERS"
panel and is assembled as the MSVGP
parameter of the DSN6ARVP macro.

MSVGP2 The mass storage volume group to be


used for the second copy of archiv e
log data sets.

This parameter is defined through the


"ARCHIVE LOG DATA SET PARAMETERS"
panel and is assembled as the MSVGP2
parameter of the DSN6ARVP macro.

SVOLARC When archiving to disk, DB2 will use


the number of online storage volumes
for the specified UNIT name to
determine a count of candidate
volumes, up to a maximum of 15
volumes.

YES indicates you want DB2 to specify


a unit and volume count of 1 when
allocating a new archive log data set
on disk.

You may want to do this when SMS


manages the archives.

This parameter is defined through the


"Archive Log Data Set Parameters"
panel and is assembled as the SVOLARC
parameter of the DSN6ARVP macro.

ARCHINPT The maximum number of archive log


volumes that can be allocated for
input mode at the same time. Archive
log data sets are read when required
for database recovery, system restart,
or dynamic backout.
This parameter is defined through the
"ARCHIVE LOG DATA SET PARAMETERS"
panel and is assembled as the MAXALLC
parameter of the MAXRTU parameter.

DEALLOCATE-MINUTES Indicates how long an archive read


tape unit is allowed to remain unused
before it is deallocated. Use this
field in conjunction with the seconds
portion to get the complete time.

This parameter can be updated once DB2


becomes active through the -SET
ARCHIVE command.

This parameter is defined through the


"ARCHIVE LOG DATA SET PARAMETERS"
panel and is assembled as the DEALLCT
parameter of the DSN6LOGP macro.

DEALLOCATE-SECONDS Indicates how long an archive read


tape unit is allowed to remain unused
before it is deallocated. Use this
field in conjunction with the minutes
portion to get the complete time.

This parameter can be updated once DB2


becomes active through the -SET
ARCHIVE command.

This parameter is defined through the


"ARCHIVE LOG DATA SET PARAMETERS"
panel and is assembled as the DEALLCT
parameter of the DSN6LOGP macro.

ARCH-CATALOG Indicates whether or not the archive


logs are cataloged.

The catalog parameter is defined


through the "ARCHIVE LOG DATA SET
PARAMETERS" panel and is assembled as
the CATALOG parameter of the DSN6ARVP
macro.

ARCH-RACF Indicates whether or not the archive


log data sets are protected by RACF
individual profiles.

The RACF protection parameter is


defined through the "PROTECTION" panel
ET and is assembled as the PROTECT
parameter of the DSN6ARVP macro.

ARCH-WTOR Indicates whether or not to send a


message to the operator and wait for a
reply before attempting to mount an
archive log data set.

The WTOR parameter is defined through


the "ARCHIVE LOG DATA SET PARAMETERS"
panel and is assembled as the ARCWTOR
parameter of the DSN6ARVP macro.

AWFLOAD Indicates whether or not on-line


initiation of the offload option
function is used.

The offload parameter is not directly


definable through any installation
panel, but is assembled as the OFFLOAD
parameter of the DSN6LOGP macro.

ARCH-COMPACTION Indicates whether or not data written


to archive logs is compacted.

The compression parameter is defined


through the "ARCHIVE LOG DATA SET
PARAMETERS" panel and is assembled as
the COMPACT parameter of the DSN6ARVP
macro.

ARCH-TIMESTAMP Indicates whether or not to timestamp


the archive.

The timestamp parameter is not


directly definable through any
installation panel, but is assembled
as the TSTAMP parameter of the
DSN6ARVP macro.

CHKPTS-BETW-UPDTS Shows the original number of


checkpoints (specified at DB2 start
up) that may occur between level ID
updates.

This value shows the checkpoint


periodicity with which attempts are
made to update a pageset or partition
level ID. A value of zero implies down
level detection is disabled.

The checkpoints between level ID


updates is not specified on any
install panel, but can be assembled as
the DLDFREQ parameter of the DSN6SYSP
macro.

UR-CHKPNT-THSHD Indicates the number of complete


checkpoint cycles before DB2 issues a
warning message to the console for a
UR.

The UR checkpoint frequency option is


specified on the "Tracing"
installation panel, and is assembled
as the URCHKTH parameter of
the DSN6SYSP macro.

UR-LOG-WRTN-THRSH Shows the current "UR log write


threshold" value.

This value indicates the number of log


records written by an uncommitted unit
of recovery (UR) before DB2 will issue
a warning message to the console. The
purpose of this option is to provide
notification of a long-running UR that
may result in a lengthy DB2 restart or
a lengthy recovery situation for
critical tables.

The value is specified in 1000 (1000


log records) increments. A value of 0
indicates that no write check is to be
done.

The "UR log write threshold" is


specified on the "Active Log Data Set
Parameters" installation panel, and is
assembled as the URLGWTH parameter of
the DSN6SYSP macro.
DBSQLDY

DBSQLDY Command

The DBSQLDY command displays information about dynamic SQL


statements that are cached for reuse. Only the 1st 60 bytes of
the SQL statement are returned.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DBSQLDy | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | If the command supports cross system data |
| | collection, this parameter forces cross system |
| | data collection to be off for this execution, |
| | but the current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Db2 subsystems |
| | on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of Db2 subsystems to be displayed. The list of |
| | available groups with type DB2SSID can be found |
| | on the GROUPS command. A group name of "*" can |
| | be entered to indicate that no group processing |
| | is required. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| DB2 | The Db2 version if the current address space is |
| | a Db2 address space. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem identifier if the current |
| | address space is a Db2 address space. |
+------------------+--------------------------------------------------+
| Mode | Specifies the current mode. |
| | Possible value are: |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
+------------------+--------------------------------------------------+
| Group | Current DB2SSID group name specified by the |
| | GROUP command parameter. |
| | This entry is displayed only when a group has |
| | been specified. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SSID | The DB2 subsystem ID. |
+------------------+--------------------------------------------------+
| SQLStatement | Shows the first 60 bytes of the SQL statement |
| | text. |
+------------------+--------------------------------------------------+
| Users | The number of current users of the SQL |
| | statement. These are the users that have |
| | prepared or executed the SQL statement during |
| | their current unit of work. |
+------------------+--------------------------------------------------+
| Copies | The number of copies of the SQL statement owned |
| | by all threads in the system. This includes |
| | QW0316US plus any copies owned by plans/packages |
| | bound with KEEPDYNAMIC(YES) that were not used |
| | in their current unit of work. |
| | |
| | These users prepared the SQL statement in a |
| | previous unit of work and still have it in a |
| | prepared state. |
+------------------+--------------------------------------------------+
| PrgName | The text of the program name. |
+------------------+--------------------------------------------------+
| StmtNum | The precompiler line number for the PREPARE |
| | statement. |
+------------------+--------------------------------------------------+
| Status | The status of the statement. If any of the |
| | following values are indicated, the statement |
| | has actually been removed from the cache but |
| | current users might still have an active copy. |
| | DB2 continues to track the statement until the |
| | use count and copy count are zero. Valid values |
| | are: |
| | |
| | DROPALTR - invalidated by DROP or ALTER |
| | REVOKE - invalidated by REVOKE |
| | LRU - removed from cache by LRU |
| | RUNSTATS - invalidated by RUNSTATS |
+------------------+--------------------------------------------------+
| InsTime | The time when the statement was inserted into |
| | the cache. |
+------------------+--------------------------------------------------+
| InsDate | The date when the statement was inserted into |
| | the cache. |
+------------------+--------------------------------------------------+
| Execs | The number of executions of a statement. For a |
| | cursor statement, this is the number of opens. |
+------------------+--------------------------------------------------+
| SyncRead | The number of synchronous buffer reads performed |
| | for the statement. |
+------------------+--------------------------------------------------+
| GetPages | The number of getpage operations performed for |
| | the statement. |
+------------------+--------------------------------------------------+
| RowsExam | The number of rows examined for the statement. |
+------------------+--------------------------------------------------+
| RowsProc | The number of rows processed for the statement |
| | For example, the number of rows returned for a |
| | SELECT, or the number of rows affected by an |
| | INSERT, UPDATE, or DELETE. |
| | |
| | IFCID 318 must be active to collect this data. |
+------------------+--------------------------------------------------+
| Sorts | The number of sorts performed for the statement. |
+------------------+--------------------------------------------------+
| IndxScan | The number of index scans performed for the |
| | statement. |
+------------------+--------------------------------------------------+
| TbspScan | The number of tablespace scans performed for the |
| | statement. |
| | |
| | IFCID 318 must be active to collect this data. |
+------------------+--------------------------------------------------+
| CPU | The accumulated CPU time. |
+------------------+--------------------------------------------------+
| IOWt | The accumulated wait time for synchronous I/O. |
| | |
| | This wait time is collected only when a class 3 |
| | accounting trace is started. |
+------------------+--------------------------------------------------+
| LockWt | The accumulated wait time for lock and latch |
| | requests. |
| | |
| | This wait time is collected only when a class 3 |
| | accounting trace is started. |
+------------------+--------------------------------------------------+
| SyncExWt | The accumulated wait time for a synchronous |
| | execution unit switch. |
| | |
| | This wait time is collected only when a class 3 |
| | accounting trace is started. |
+------------------+--------------------------------------------------+
| GlbLkWt | The accumulated wait time for global locks. |
| | |
| | This wait time is collected only when a class 3 |
| | accounting trace is started. |
+------------------+--------------------------------------------------+
| ReadWt | The accumulated wait time for read activity that |
| | is done by another thread. |
| | |
| | This wait time is collected only when a class 3 |
| | accounting trace is started. |
+------------------+--------------------------------------------------+
| OtherWt | The accumulated wait time for write activity |
| | that is done by another thread. |
| | |
| | This wait time is collected only when a class 3 |
| | accounting trace is started. |
+------------------+--------------------------------------------------+
| ParaGrps | The number of parallel groups created for the |
| | statement. |
| | |
| | IFCID 318 must be active to collect this data. |
+------------------+--------------------------------------------------+
| SyncRead | The number of synchronous buffer reads performed |
| | for the statement. |
| | |
| | IFCID 318 must be active to collect this data. |
+------------------+--------------------------------------------------+
| SyncWrit | The number of synchronous buffer write |
| | operations performed for the statement. |
| | |
| | IFCID 318 must be active to collect this data. |
+------------------+--------------------------------------------------+
| Elapsed | The accumulated elapsed time used for the |
| | statement. |
| | |
| | IFCID 318 must be active to collect this data. |
+------------------+--------------------------------------------------+
| SQLLen | The length of the entire statement. |
+------------------+--------------------------------------------------+
| TrnLen | The length of the transaction name. |
+------------------+--------------------------------------------------+
| TrnName | The transaction name. |
+------------------+--------------------------------------------------+
| UserID | The user ID. |
+------------------+--------------------------------------------------+
| UserGrp | The user group name. The user group is the |
| | current SQLID of the user who did the initial |
| | PREPARE. |
+------------------+--------------------------------------------------+
| UnqualQ | The qualifier that is used for unqualified table |
| | names. |
+------------------+--------------------------------------------------+
| ISOBind | The value of the BIND option isolation that is |
| | in effect for the initial PREPARE. This value |
| | does not reflect the value that is specified in |
| | a WITH clause. Valid values are: |
| | |
| | UR - (UNCOMMITTED READ) |
| | CS - (CURSOR STABILITY) |
| | RS - (READ STABILITY) |
| | RR - (REPEATABLE READ) |
+------------------+--------------------------------------------------+
| DataBind | The CURRENTDATA BIND option. Displays DataBind |
| | when set to YES or spaces when set to NO. |
+------------------+--------------------------------------------------+
| RuleBind | The DYNAMICRULES bind option. Valid values are |
| | BIND or RUN. |
+------------------+--------------------------------------------------+
| CurrDeg | The value of the current degree special register |
| | at bind. Valid values are ANY or 1. |
+------------------+--------------------------------------------------+
| CurRules | The value of the current rules special register |
| | at bind. |
+------------------+--------------------------------------------------+
| CurrPrec | The value of the current precision special |
| | register at bind. |
+------------------+--------------------------------------------------+
| CsrHold | Indicates whether the statement cursor is a held |
| | cursor. Displays CsrHold when YES or blanks when |
| | NO. |
+------------------+--------------------------------------------------+
| ColStrt | The time when statistics collection begins. Data |
| | collection begins when a trace for IFCID 318 is |
| | started. |
+------------------+--------------------------------------------------+
| ColDate | The date when statistics collection begins. Data |
| | collection begins when a trace for IFCID 318 is |
| | started. |
+------------------+--------------------------------------------------+
| TblQual | The qualifier of the referenced table name. |
+------------------+--------------------------------------------------+
| TblName | The name of the referenced table. |
+------------------+--------------------------------------------------+
| RIDLimit | Number of times that a RID list was not used |
| | because the number of RIDs would have exceeded |
| | one or more internal DB2 limits. |
+------------------+--------------------------------------------------+
| RIDStor | Number of times that a RID list was not used |
| | because not enough storage was available. |
+------------------+--------------------------------------------------+
| UserStr | User-provided identification string for the |
| | cached statement. |
+------------------+--------------------------------------------------+
| Schema | Current schema special register text. |
+------------------+--------------------------------------------------+
| StmtID | The statement identifier. |
+------------------+--------------------------------------------------+
| UniqueID | Unique statement identifier. A generated number |
| | for uniquely identifying a statement in the |
| | prepared statement cache. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands
No line commands are defined by the &HelpMember command, however
other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
DBSTG

DBSTG Command

The DBSTG command displays storage utilization statistics for the DB2
subsystem as recorded in the IFCID 225 record.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DBSTG | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | If the command supports cross system data |
| | collection, this parameter forces cross system |
| | data collection to be off for this execution, |
| | but the current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Db2 subsystems |
| | on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of Db2 subsystems to be displayed. The list of |
| | available groups with type DB2SSID can be found |
| | on the GROUPS command. A group name of "*" can |
| | be entered to indicate that no group processing |
| | is required. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| DB2 | The Db2 version if the current address space is |
| | a Db2 address space. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem identifier if the current |
| | address space is a Db2 address space. |
+------------------+--------------------------------------------------+
| Mode | Specifies the current mode. |
| | Possible value are: |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
+------------------+--------------------------------------------------+
| Group | Current DB2SSID group name specified by the |
| | GROUP command parameter. |
| | This entry is displayed only when a group has |
| | been specified. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SSID | The DB2 subsystem ID. |
+------------------+--------------------------------------------------+
| AgtLclPool | Agent local pool storage usage. |
+------------------+--------------------------------------------------+
| AgtSys | Agent system storage usage. |
+------------------+--------------------------------------------------+
| Available | The amount of available storage. |
+------------------+--------------------------------------------------+
| CompDict | The total storage for the compression |
| | dictionary. |
+------------------+--------------------------------------------------+
| MustComp | The storage reserved only for must-complete |
| | operations within DB2. |
+------------------+--------------------------------------------------+
| TotFixed | The total fixed storage. |
+------------------+--------------------------------------------------+
| GetM | The total allocated storage. |
+------------------+--------------------------------------------------+
| GetMStack | The total getmained stack storage. |
+------------------+--------------------------------------------------+
| MVSUse | The the amount of storage for z/OS usage. |
+------------------+--------------------------------------------------+
| PipeMgr | The total storage for the pipe manager subpool. |
+------------------+--------------------------------------------------+
| RDSOpt | The total storage for the RDS optimizer pool. |
+------------------+--------------------------------------------------+
| RID | The the total storage for RID pool. |
+------------------+--------------------------------------------------+
| StmtCache | The total storage for the statement cache block. |
+------------------+--------------------------------------------------+
| ThdSQL | The total storage for thread copies of cached |
| | SQL statements. |
+------------------+--------------------------------------------------+
| Cushion | The storage cushion warning to storage |
| | contraction. |
+------------------+--------------------------------------------------+
| TraceTab | The total storage for the buffer manager or data |
| | manager internal trace table. |
+------------------+--------------------------------------------------+
| Variable | The total variable storage. |
+------------------+--------------------------------------------------+
| 24bitLowPvt | The MVS 24-bit low private storage |
+------------------+--------------------------------------------------+
| 24bitHiPvt | The MVS 24-bit high private storage. |
+------------------+--------------------------------------------------+
| 31bitLowPvt | The MVS 31-bit extended low private storage. |
+------------------+--------------------------------------------------+
| 31bitHiPvt | The MVS 31-bit extended high private storage. |
+------------------+--------------------------------------------------+
| MaxExtRgn | The MVS maximum extended region size. |
+------------------+--------------------------------------------------+
| MaxExtCSA | The MVS extended CSA size. |
+------------------+--------------------------------------------------+
| BufBelBar | The total buffer manager storage blocks below |
| | the 31-bit bar. |
+------------------+--------------------------------------------------+
| FxdAbvBar | The total fixed storage above the 31-bit bar. |
+------------------+--------------------------------------------------+
| GtMAbvBar | The total getmained storage above the 31-bit bar.|
+------------------+--------------------------------------------------+
| VarAbvBar | The total variable storage above the 31-bit bar. |
+------------------+--------------------------------------------------+
| SJAbvBar | The total Starjoin memory pool storage above the |
| | 31-bit bar. |
+------------------+--------------------------------------------------+
| Frames | The number of real frames that are in use. Each |
| | frame is 4 KB. |
+------------------+--------------------------------------------------+
| AuxSlots | The number of auxiliary slots that are in use. |
| | Each slot is 4 KB. |
+------------------+--------------------------------------------------+
| Fxd64bitShr | The total fixed virtual shared storage above the |
| | bar. |
+------------------+--------------------------------------------------+
| GtM64bitShr | The total getmained virtual 64-bit shared |
| | storage. |
+------------------+--------------------------------------------------+
| Var64bitShr | The total variable virtual shared storage above |
| | the bar. |
+------------------+--------------------------------------------------+
| Stack | The total stack storage in use. |
+------------------+--------------------------------------------------+
| ActThreads | The number of active allied threads. |
+------------------+--------------------------------------------------+
| CastoutEng | The number of castout engines allocated. |
+------------------+--------------------------------------------------+
| DefWrEng | The number of deferred write engines allocated. |
+------------------+--------------------------------------------------+
| GBPWrEng | The number of GBP write engines allocated. |
+------------------+--------------------------------------------------+
| PrefChEng | The number of prefetch engines allocated. |
+------------------+--------------------------------------------------+
| PlkExitEng | The number of physical lock (p-lock)/notify exit |
| | engines allocated. |
+------------------+--------------------------------------------------+
| CachedStmt | The number of dynamic statements that are |
| | allocated (active). |
+------------------+--------------------------------------------------+
| CSThread | The total amount of storage that is used for |
| | allocated (active) dynamic statements. |
+------------------+--------------------------------------------------+
| CSThdHWM | The highest value for storage for allocated |
| | (active) dynamic statements in the statistics |
| | interval. |
+------------------+--------------------------------------------------+
| CSHWM | The number of allocated (active) dynamic |
| | statements when the highest value for storage |
| | for allocated dynamic statements (QW0225HS) was |
| | recorded. |
+------------------+--------------------------------------------------+
| CSHWMDate | The date at which the highest value for storage |
| | for allocated (active) dynamic statements |
| | (QE0225HS) was recorded. |
+------------------+--------------------------------------------------+
| CSHWMTime | The time at which the highest value for storage |
| | for allocated (active) dynamic statements |
| | (QE0225HS) was recorded. |
+------------------+--------------------------------------------------+
| CS64bitThd | Specifies currently allocated storage for thread |
| | copies in the "cached SQL statements above" |
| | pool. |
+------------------+--------------------------------------------------+
| CS64bitHWM | The maximum allocated storage for thread copies |
| | in the "cached statements above" pool. |
+------------------+--------------------------------------------------+
| TotCS64bit | The total statement cache block storage above |
| | the bar. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
DBSYSSUM

DBSYSSUM Command

The DBSYSSUM command displays a system status overview of the


Db2 address spaces.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DBSYSSUM | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | |
| | [ INTerval | TOTal ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | If the command supports cross system data |
| | collection, this parameter forces cross system |
| | data collection to be off for this execution, |
| | but the current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Db2 subsystems |
| | on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of Db2 subsystems to be displayed. The list of |
| | available groups with type DB2SSID can be found |
| | on the GROUPS command. A group name of "*" can |
| | be entered to indicate that no group processing |
| | is required. |
+------------------+--------------------------------------------------+
| INTerval | Displays interval data, which is the difference |
| | between the most current interval and the |
| | previously collected data. |
+------------------+--------------------------------------------------+
| TOTal | Displays data representing total statistical |
| | accumulation since DB2 was started. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| DB2 | The Db2 version if the current address space is |
| | a Db2 address space. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem identifier if the current |
| | address space is a Db2 address space. |
+------------------+--------------------------------------------------+
| Mode | Specifies the current mode. |
| | Possible value are: |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
+------------------+--------------------------------------------------+
| Group | Current DB2SSID group name specified by the |
| | GROUP command parameter. |
| | This entry is displayed only when a group has |
| | been specified. |
+------------------+--------------------------------------------------+
| Interval | Specifies the data collection mode. |
| | Possible value are: |
| | [###] - When the INTerval parm is specified |
| | or the default is used, this value |
| | is the data collection interval |
| | duration. |
| | DELTA - When the INTerval parm is specified |
| | or the default is used, but the |
| | interval start and end are not |
| | available. |
| | TOTAL - The TOTAL parameter was specified |
| | and the numbers displayed are |
| | totals since DB2 was started. |
+------------------+--------------------------------------------------+
| Start | Indicates the start time for the interval. |
| | This label is only displayed when interval data |
| | data collection is being displayed. |
+------------------+--------------------------------------------------+
| End | Indicates the end time for the interval. |
| | This label is only displayed when interval data |
| | data collection is being displayed. |
+------------------+--------------------------------------------------+

Data Fields
Default Sort Order: XSSystem,A,SSID,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem ID. |
+------------------+--------------------------------------------------+
| Release | The Db2 version number. |
+------------------+--------------------------------------------------+
| Cpf | The subsystem recognition character (SRC) for |
| | the Db2 subsystem. The SRC must prefix every |
| | command issued from a console for this |
| | subsystem. |
+------------------+--------------------------------------------------+
| DDFStat | Indicates whether the distributed data facility |
| | is started (ACTIVE) or not (INACTIVE). |
+------------------+--------------------------------------------------+
| RLFStat | Indicates whether the resource limit facility is |
| | started (ACTIVE) or not (INACTIVE). |
+------------------+--------------------------------------------------+
| DSGroup | The name of the Db2 data sharing group. |
+------------------+--------------------------------------------------+
| Elapsed | The Db2 elapsed time since startup. |
+------------------+--------------------------------------------------+
| Date | The Db2 start date and time. |
| Time | |
+------------------+--------------------------------------------------+
| BPAct | The current number of buffer pools allocated. |
+------------------+--------------------------------------------------+
| BPWarn | The current total of all exceptions for each |
| | active buffer pool. |
+------------------+--------------------------------------------------+
| BPPage% | The percentage of active (in use or updated) |
| | pages in the buffer pool. |
+------------------+--------------------------------------------------+
| GetPages | The number of buffer pool GETPAGE requests for a |
| | thread, including all unconditional and |
| | successful conditional requests. |
+------------------+--------------------------------------------------+
| ReadIOs | The number of synchronous physical I/O |
| | operations performed to read pages of data from |
| | Db2 tables. |
+------------------+--------------------------------------------------+
| WriteIOs | The number of synchronous and asynchronous |
| | write I/O operations performed. |
+------------------+--------------------------------------------------+
| Threads | The number of successful Create Threads |
| | processed by the Subsystem Services component of |
| | Db2. This count does not include database access |
| | threads (DBATs). |
+------------------+--------------------------------------------------+
| SQL | The number of SQL statements. |
+------------------+--------------------------------------------------+
| Commits | The number of successful phase-2 or single-phase |
| | commit (sync) requests issued by currently |
| | executing threads. |
+------------------+--------------------------------------------------+
| Aborts | The number of rollback requests issued by |
| | currently executing threads. This count |
| | indicates the number of units of recovery that |
| | were backed out and includes rollbacks from |
| | attaches. |
+------------------+--------------------------------------------------+
| ThrdAct | The current number of active users in Db2. The |
| | maximum number of active users is defined by the |
| | ZPARM parameter, CTHREAD. |
+------------------+--------------------------------------------------+
| TSOConn | The number of TSO connections in use. |
+------------------+--------------------------------------------------+
| BatchConn | The number of connections to Db2 from batch. |
+------------------+--------------------------------------------------+
| DDFAct | The number of active remote connections. The |
| | maximum number of remote connections is defined |
| | by the ZPARM parameter MAXDBAT. |
+------------------+--------------------------------------------------+
| DDFInact | The number of inactive remote connections. The |
| | maximum number of active and inactive remote |
| | connections is defined by the ZPARM parameter |
| | CONDBAT. |
+------------------+--------------------------------------------------+
| ThrdInd | The current number of indoubt threads. |
+------------------+--------------------------------------------------+
| TimeOuts | The number of times an application was unable |
| | to obtain a lock from the lock manager (IRLM) |
| | after waiting for an installation-specified |
| | time interval. Db2 aborts processing backs out |
| | out the current unit of work (that is, erases |
| | any changes made since the last COMMIT). |
+------------------+--------------------------------------------------+
| DeadLocks | The number of times an application was unable to |
| | obtain a lock from the lock manager (IRLM) due |
| | to a deadlock situation. |
+------------------+--------------------------------------------------+
| CheckPoint | The number of minutes per checkpoint. |
+------------------+--------------------------------------------------+
| SubSysC | The number of critical subsystem exceptions |
| | detected during the last exception cycle. |
+------------------+--------------------------------------------------+
| SubSysW | The number of warning subsystem exceptions |
| | detected during the last exception cycle. |
+------------------+--------------------------------------------------+
| SubSysI | The number of information subsystem exceptions |
| | detected during the last exception cycle. |
+------------------+--------------------------------------------------+
| DBaseC | The number of critical database exceptions |
| | detected during the last exception cycle. |
+------------------+--------------------------------------------------+
| DBaseW | The number of warning database exceptions |
| | detected during the last exception cycle. |
+------------------+--------------------------------------------------+
| DBaseI | The number of information database exceptions |
| | detected during the last exception cycle. |
+------------------+--------------------------------------------------+
| ApplC | The number of critical application exceptions |
| | detected during the last exception cycle. |
+------------------+--------------------------------------------------+
| ApplW | The number of warning application exceptions |
| | detected during the last exception cycle. |
+------------------+--------------------------------------------------+
| ApplI | The number of information application exceptions |
| | detected during the last exception cycle. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the DETAILS DBSYSSUM command to display |
| | a detailed report for the selected subsystem. |
| | Data displayed represents either: |
| | |
| | The last data collection interval if |
| | currently in INTERVAL mode. |
| | |
| | Totals since the Db2 subsystem was started if |
| | currently in TOTAL mode. |
+------------------+--------------------------------------------------+
| INTerval | Invokes the DETAILS DBSYSSUM command to display |
| | a detailed report for the selected subsystem. |
| | Data displayed represents the last data |
| | collection interval. |
+------------------+--------------------------------------------------+
| TOTal | Invokes the DETAILS DBSYSSUM command to display |
| | a detailed report for the selected subsystem. |
| | Data displayed represents totals since the Db2 |
| | subsystem was started. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
DBTHACT

DBTHACT Command

The DBTHACT command displays information about active DB2 threads.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DBTHAct | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | If the command supports cross system data |
| | collection, this parameter forces cross system |
| | data collection to be off for this execution, |
| | but the current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Db2 subsystems |
| | on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of Db2 subsystems to be displayed. The list of |
| | available groups with type DB2SSID can be found |
| | on the GROUPS command. A group name of "*" can |
| | be entered to indicate that no group processing |
| | is required. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| DB2 | The Db2 version if the current address space is |
| | a Db2 address space. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem identifier if the current |
| | address space is a Db2 address space. |
+------------------+--------------------------------------------------+
| Mode | Specifies the current mode. |
| | Possible value are: |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
+------------------+--------------------------------------------------+
| Group | Current DB2SSID group name specified by the |
| | GROUP command parameter. |
| | This entry is displayed only when a group has |
| | been specified. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SSID | The DB2 subsystem ID. |
+------------------+--------------------------------------------------+
| Jobname | The jobname where the thread request originated. |
+------------------+--------------------------------------------------+
| AuthId | The primary authorization ID of the DB2 thread. |
| | If the ID is longer than 16 characters it will |
| | be truncated. |
+------------------+--------------------------------------------------+
| CorrId | The thread identifier or correlation ID that is |
| | associated with the thread. Valid values are |
| | based on connection type: |
| | |
| | for: |
| | TSO TSO LOGON is assigned |
| | BATCH Batch jobname is assigned |
| | UTILITY batch jobname is assigned |
| | Call ATTACH batch jobname/TSO LOGON ID |
| | CICS 1st character = connection type: |
| | G = group |
| | P = pool |
| | 2nd character = thread type: |
| | T = transaction |
| | G = group |
| | C = command |
| | Chars 3-4 = thread number |
| | Chars 5-8 = transaction ID |
| | |
| | IMS/VS pst#.psbname |
| | Distributed If the application requestor |
| | (AR) is a DB2 system, then it is |
| | the same value that was assigned |
| | at the AR |
| | |
| | If the application requestor is |
| | not a DB2 system, then the value |
| | is the name (possibly truncated) |
| | of the job, task, or proces that |
| | the AR is servicing. The sends |
| | the name to the application |
| | server (AS) in the EXTNAM |
| | parameter of the DDM EXCSAT |
| | command. The DB2 AS stores up |
| | to the first 12 characters of |
| | this name padded on the right |
| | with blanks if the length is |
| | less thatn 12. The value is |
| | blank if no EXTNAM is supplied |
+------------------+--------------------------------------------------+
| PlanName | Identifies the name of the application plan |
| | specified when using the BIND command under the |
| | DSN processor. For DB2 command threads and |
| | threads in identify status, the plan name will |
| | be blanks. |
| | |
| | A plan is made up of one or more DBRMs or |
| | packages generated by the DB2 precompiler. When |
| | a plan is bound by DB2 it goes through a plan |
| | segmentation process. This process divides a |
| | plan into sections that can be independently |
| | loaded into the EDM pool as they are needed. |
+------------------+--------------------------------------------------+
| Status | The DB2 status of the thread. Valid values are: |
| | .... The thread is in a state where |
| | active thread detail is not |
| | available, usually because it |
| | hasn't begun its first process yet |
| | ACTIVE-A The thread is executing |
| | application code |
| | ACTIVE-D The thread is executing SQL code |
| | CHILD-D CHILD thread executing SQL code |
| | CHILDSUM CHILD summary thread not executing |
| | in DB2 code |
| | CHSUM-D CHILD summary thread executing in |
| | DB2 code |
| | CREATE-Q The agent is known to DB2 and is |
| | waiting for a thread to be created |
| | DDF The thread is waiting for a |
| | message from a remote site or is a |
| | DBAT thread executing in the DB2 |
| | DIST address space. |
| | DDFREUSE The thread is a DBAT thread |
| | executing in the DB2 DIST address |
| | space and is eligible for reuse, |
| | per the ACCUMACC DB2 ZPARM option |
| | EOT The thread is terminating |
| | EOT-Q The thread is queued for |
| | termination |
| | IDENTIFY The agent is known to DB2, but is |
| | not currently engaged in a process |
| | INACT-1 A type 1 inactive thread |
| | INACT-2 A type 2 inactive thread |
| | LOCKWAIT The thread is waiting for another |
| | thread to release a lock on a |
| | resource |
| | PARENT-D PARENT thread executing SQL code |
| | PARENT-A PARENT thread executing |
| | application code |
| | ROLLUP A DDF/RRSAF rollup accounting |
| | thread. They exist when the DB2 |
| | ZPARM ACCUMACC is set to a value |
| | greater than 1. |
| | WAITREUS A CICS protected thread waiting |
| | reuse |
+------------------+--------------------------------------------------+
| LastEvent | Last IFCID event text. Valid values are: |
| | RD I/O IFC ID 0006 for RMID 10 |
| | Records the ID of the data set |
| | before a read I/O operation |
| | WR I/O IFC ID 0008 for RMID 10 |
| | Records the ID of the data set |
| | before a write I/O operation |
| | (Synchronous) |
| | ASYNWR IFC ID 0010 for RMID 10 |
| | Records the ID of the data set |
| | before a write I/O operation |
| | (Asynchronous) |
| | EDM IFC ID 0029 for RMID 14 |
| | Records EDM request start |
| | LOGMGR IFC ID 0032 for RMID 04 |
| | Records begin wait for log manager |
| | LOG RD IFC ID 0034 for RMID 04 |
| | Records log manager wait for read |
| | I/O |
| | LOGOTH IFC ID 0036 for RMID 04 |
| | Records log manager wait for non |
| | I/O begin |
| | LOG WR IFC ID 0038 for RMID 04 |
| | Records log manager wait for active |
| | log write I/O begin |
| | LOCK IFC ID 0044 for RMID 20 |
| | Records lock suspend or an identify |
| | call to the IRLM |
| | SHRLAT IFC ID 0052 for RMID 02 |
| | Records a shared wait |
| | EXCLAT IFC ID 0056 for RMID 02 |
| | Records an exclusive latch wait |
| | ASYNRD IFC ID 0127 for RMID 10 |
| | Records the event that an agent is |
| | ready to suspend itself to wait for |
| | a page for which I/O is in progress |
| | under another agent |
| | SRVTSK IFC ID 0170 for RMID 02 |
| | Records the suspend of an agent |
| | that is waiting for the execution |
| | of a DB2 service task |
| | IFI QW0187 is signalled when processing |
| | enters IFI. It is signalled again |
| | when processing exits IFI. These |
| | signals are used to calculate the |
| | in-IFI elapsed and CPU class 5 |
| | times. Class 5 time is a subset of |
| | class 2 time, but is not equal to |
| | class 3 time, because it can include|
| | class 3 time also. IFCID 187 can |
| | be activated by starting accounting |
| | or monitor class 5. IFCID 187 is |
| | never written to any trace data |
| | set. Instead, it serves only as a |
| | signal to determine whether or not |
| | class 5 timing processing should be |
| | conducted |
| | .... Indicates that the thread is in a |
| | state where active thread detail is |
| | not available, usually because it |
| | hasn't begun its first process yet, |
| | or it is a rollup thread |
+------------------+--------------------------------------------------+
| Db2Time | Shows the total "in DB2" elapsed time. It is a |
| | summation of the traditional application "in DB2"|
| | time, plus "in DB2" time spent processing stored |
| | procedures, user defined functions, and triggers |
| | on behalf of the application. All of these |
| | fields are recorded separately in accounting |
| | data from DB2. The accounting class 2 trace |
| | must be acdtive to collect this data. |
+------------------+--------------------------------------------------+
| Db2Cpu | The CPU time used while in DB2. This includes |
| | DB2 CPU time used by stored procedures, user |
| | defined functions, and triggers. This time also |
| | includes zIIP CPU usage from both locally |
| | executed SQL as well as stored procedures and |
| | user defined funcdtions executed in a WLM |
| | stored procedure address space. |
+------------------+--------------------------------------------------+
| Db2IO | The time in DB2 that the thread spent processing |
| | I/O requests or waiting for I/O requests |
| | performed for other threads. |
| | |
| | The accounting class 3 trace must be active to |
| | collect this data. |
+------------------+--------------------------------------------------+
| AvgIoElap | The average elapsed time in DB2 that the thread |
| | spent processing I/O requests. |
| | |
| | This field is for synchronous I/O only. It |
| | includes synchronous read and write I/O |
| | (including selected synchronous log I/O). |
| | |
| | The accounting class 3 trace must be active to |
| | collect this data. |
+------------------+--------------------------------------------------+
| Crit | The number of critical application exceptions |
| | detected during the last exception cycle. |
+------------------+--------------------------------------------------+
| Warn | The number of warning application exceptions |
| | detected during the last exception cycle. |
+------------------+--------------------------------------------------+
| Info | The number of informational application |
| | exceptions detected during the last exception |
| | cycle. |
+------------------+--------------------------------------------------+
| CmtAbort | The number of commits and aborts. For IMS and |
| | CICS threads, this is a transaction tally. |
+------------------+--------------------------------------------------+
| LLSuspend | The time for which the application was suspended |
| | while waiting for a DB2 resource or a serializing|
| | process (latch). It includes DB2 V3 fields, |
| | page latch wait time, time the requester is |
| | suspended while waiting to acquire the drain |
| | lock, and time waiting for claims to be released.|
| | It also includes the DB2 V4 wait time for global |
| | lock contentions. |
| | |
| | The accounting class 3 trace must be active to |
| | collect this data. |
+------------------+--------------------------------------------------+
| LogWait | The accumulated time in DB2 that the application |
| | waited for an archive read from tape or was |
| | suspended due to an -ARCHIVE LOG MODE(QUIESCE) |
| | command. |
| | |
| | This quiesce wait time is the actual suspend time|
| | for the individual thread, and not the time it |
| | took for the entire command to complete. |
| | |
| | The accounting class 3 trace must be active to |
| | collect this data. |
+------------------+--------------------------------------------------+
| Db2SvcWait | The time spent waiting due to synchronous |
| | execution unit switches to DB2 services. |
| | |
| | The following DB2 service waits are included in |
| | this field: |
| | o open/close data set |
| | o SYSLGRNG update |
| | o HSM recall data set |
| | o commit phase 2 (for read only threads |
| | originating from TSO or batch) |
| | o dataspace mgr services |
| | - define data set |
| | - extend data set |
| | - delete data set |
+------------------+--------------------------------------------------+
| RoutineWt | The total elapsed time spent waiting for an |
| | available TCB before the stored procedure could |
| | be scheduled. |
| | |
| | The accounting class 3 trace must be active to |
| | collect this data. |
+------------------+--------------------------------------------------+
| GetPage | The number of buffer pool GETPAGE requests for a |
| | thread. This includes successful requests for |
| | pages for queries that are processed in parallel |
| | and both successful and unsuccessful requests |
| | for pages for queries that are not processed in |
| | parallel. |
| | |
| | GETPAGE requests occur when DB2 accesses pages |
| | in the buffer pools to satisfy application |
| | requests. |
+------------------+--------------------------------------------------+
| SyncRead | Indicates how many synchronous physical I/O |
| | operations have occurred to read pages of data |
| | from DB2 tables. |
+------------------+--------------------------------------------------+
| AvgRdEff | The ration of GETPAGE requests to Synchronous |
| | I/O operations. |
+------------------+--------------------------------------------------+
| Prefetch | Shows the number of prefetch I/O operations. |
+------------------+--------------------------------------------------+
| BpUpdates | Indicates the number of records that were |
| | updated in the buffer pool. |
| | |
| | This counter includes updates to index records |
| | as well as table updates. Furthermore, if the |
| | same record is updated twice within the same |
| | logical unit of work, then it is counted as two |
| | updates. |
+------------------+--------------------------------------------------+
| BpWarn | This field records the buffer pool exceptions |
| | for threads. The conditions included in the |
| | counter are: |
| | o Hiperpool Page Read Failed |
| | o Hiperpool Page Wrt Failed |
| | o Conditional Getpage Failed |
| | o Synchronous write I/O |
+------------------+--------------------------------------------------+
| SqlSelects | The number of SQL SELECT statements issued. |
+------------------+--------------------------------------------------+
| SqlFetches | The number of SQL FETCH cursor statements issued.|
+------------------+--------------------------------------------------+
| SqlInUpDel | The number of SQL INSERT, UPDATE, DELETE, MERGE, |
| | and TRUNCATE TABLE statements executed. |
+------------------+--------------------------------------------------+
| SqlPrepares | The number of SQL PREPARE statements issued. |
+------------------+--------------------------------------------------+
| SqlCallSts | The number of SQL CALL statements issued. |
+------------------+--------------------------------------------------+
| CallFails | This field shows the accumulated number of |
| | failures related to SQL CALL statements and |
| | stored procedure usage. Values included in this |
| | field are: |
| | o Stored procdure abends |
| | o SQL CALL timeouts - SQL CALL rejected |
+------------------+--------------------------------------------------+
| DllDml | The total number of SQL GRANT, REVOKE, and DDL |
| | type statements issued. |
+------------------+--------------------------------------------------+
| MxPgLocks | Indicates the maximum number of page or row |
| | locks held by an application at any given point. |
+------------------+--------------------------------------------------+
| SuspLocks | This field shows the accumulated number of times |
| | that an application trying to obtain a lock from |
| | the lock manager (IRLM) was delayed because the |
| | resource was being held by another task with an |
| | incompatible lock. |
+------------------+--------------------------------------------------+
| DeadLocks | The accumulated number of times that an |
| | application was unable to obtain a lock from the |
| | lock manager (IRLM) due to a deadlock situation. |
+------------------+--------------------------------------------------+
| Timeouts | The accumulated number of times that an |
| | application was unable to obtain a lock from the |
| | lock manager (IRLM) after waiting for an |
| | installation-specified time interval. DB2 |
| | aborts processing and backs out the current unit |
| | of work (erases any changes made since the last |
| | COMMIT). |
| | |
| | DB2 waits the amount of time specified on the |
| | DSNZPARM parameter,IRLMRWT, for transactions and |
| | queries to receive a lock. Furthermore, it will |
| | wait twice this value for IMS/VS BMPs to get a |
| | lock, and three times this value for batch jobs |
| | and utilities. |
+------------------+--------------------------------------------------+
| Escalations | The accumulated number of times that DB2 |
| | successfully performed a lock escalation on a |
| | table space from either an "intent to share" (IS)|
| | lock to shared (S) table space lock or from an |
| | "intent for exclusive" (IX) lock to an |
| | exclusive (X) table space lock. |
+------------------+--------------------------------------------------+
| PrefNoStg | Shows the number of times list prefetch failed |
| | because the storage necessary to allocate more |
| | RID blocks to hold the list of record |
| | identifiers (RIDs) was not available in the DBM1 |
| | private address space. DB2 continues to process |
| | the data without using list prefetch. |
+------------------+--------------------------------------------------+
| ParallelErr | The number of query parallelism excpetions for |
| | threads. The conditions included are: |
| | o Reduced degree |
| | o Parallel to sequential |
+------------------+--------------------------------------------------+
| ThdLogRecs | The number of log records written. |
+------------------+--------------------------------------------------+
| CicsTask | For a CICS thread, the current CICS task number |
| | using the DB2 thread. |
+------------------+--------------------------------------------------+
| CicsTran | For a CICS thread, the current CICS transaction |
| | ID. |
+------------------+--------------------------------------------------+
| OwnProg | Indicates the owning statement's program name. |
| | A program is the name of the package ID or |
| | database request module (DBRM) from which the |
| | current statement is being executed. A package |
| | or DBRM is a collecdtion of SQL statements |
| | generated by the DB2 precompiler. |
+------------------+--------------------------------------------------+
| EndUserWorkstn | The end user's workstation name. This field |
| | be blank if the client did not supply this |
| | information. |
+------------------+--------------------------------------------------+
| EndUserUserId | The end user's workstation user ID. This may be |
| | different from the authorization ID used to |
| | connect to DB2. This field will be blank if the |
| | client did not supply this information. |
| | |
| | This field contains a truncated name if it is |
| | longer than 16 characters. |
+------------------+--------------------------------------------------+
| EndUserTrans | The transaction or application name that the end |
| | user is running. This identifies the application |
| | that is currently running rather than the |
| | product that is being used to run the application|
| | (e.g. CICS/6000). This field will be blank if |
| | the client did not supply this information. |
+------------------+--------------------------------------------------+
| Program | Name of the current DB2 program. |
+------------------+--------------------------------------------------+
| Statement | Precompiler statement number of the current or |
| | most recently executed SQL statement. |
+------------------+--------------------------------------------------+
| LstPgAcc | Database name (or DBID) of the last pageset for |
| | for which I/O took place. |
+------------------+--------------------------------------------------+
| Page | Page number of the last pageset for which I/O |
| | took place. |
+------------------+--------------------------------------------------+
| PageSet | Pageset name (or PSID) or the last pageset for |
| | which I/O took place. |
+------------------+--------------------------------------------------+
| WlmClass | The workload manager service class name if the |
| | thread is a DBAT and if the MVS release and |
| | system defintions invoke this function. |
| | Otherwise, this field will be blank. |
+------------------+--------------------------------------------------+
| ThdType | The thread type. Valid values are: |
| | Allied-D This thread services a program |
| | running in an allied address space |
| | and it has requested information |
| | from a remote DB2 |
| | Allied-N This is a "normal" non-distributed |
| | thread that services a program |
| | running in an allied address space |
| | Allied-N This is a Database Access Thread |
| | which was created by DB2 to |
| | service a request for information |
| | from a remote DB2 |
+------------------+--------------------------------------------------+
| ExtendedStatus | The current status of the DB2 application. |
| | Valid values are: |
| | IN USER The application is not currently |
| | procssing an SQL statement or DB2 |
| | function |
| | IN DB2 The application is processing an |
| | SQL statement or DB2 function |
| | DDF The distributed thread of a request |
| | from another location |
| | REMOTE An allied thread location |
| | QDELETE The thread is a termination of the |
| | associated allied task. |
| | If this thread is also the last (or |
| | only) DB2 thread for the address |
| | space, the associated allied task |
| | is placed in a wait state. |
| | DELETE The thread is in the termination of |
| | the associated allied task. |
| | If this thread is also the last (or |
| | only) DB2 thread for the address |
| | space, the associated allied task |
| | is placed in a wait state. |
| | |
| | Under certain circumstances, additional status |
| | text may be displayed indicating the current |
| | state of the thread, current DB2 process, or the |
| | state of the address space if it is swapped out. |
| | For example, if the application is processing |
| | "IN DB2", the additional status text may |
| | indicate a DB2 function such as dynamic bind, |
| | sorting, or waiting for a response from a remote |
| | system. |
| | |
| | If the address space is swapped out, then |
| | SWAPPED will be displayed followed by a four |
| | character swap reason code as follows: |
| | TOUT Wait terminal output |
| | TIN Wait terminal input |
| | LW Long wait |
| | AS Aux storage shortage |
| | RS Real storage shortage |
| | DET Detected wait |
| | REQ Requested swap out |
| | ENQX Enqueue exchange |
| | EXCH Exchange |
| | UNIL Unilateral swap out |
| | TRAN Transition |
+------------------+--------------------------------------------------+
| IFCID | The last IFCID that collected data for the API |
| | begin/end suspend fields. The IFCID value may |
| | be used to determine what type of suspend last |
| | took place. |
+------------------+--------------------------------------------------+
| ConnType | The type of connection. Valid values are: |
| | BAT, CAF, CICS, DBAT, DBPP, DLIB, DRBA, IMS |
| | IMSB, IMSC, IMSM, IMST, RRS, TSO, UTIL |
+------------------+--------------------------------------------------+
| ConnName | The name of the connection identified to DB2. |
+------------------+--------------------------------------------------+
| Elapsed | The elapsed time since the application first |
| | connected to DB2 with a Create Thread request. |
+------------------+--------------------------------------------------+
| StrtDate | The date the thread started. |
+------------------+--------------------------------------------------+
| StrtTime | The time the thread started. |
+------------------+--------------------------------------------------+
| ASID | The ASID of the address space where the thread |
| | request originated. |
+------------------+--------------------------------------------------+
| ThdToken | Thread token that uniquely identifies a specific |
| | thread and also appears in the DISPLAY THREAD |
| | command response. For allied threads, the token |
| | acquired at subsystem create thread and freed |
| | during terminate thread. For database access |
| | threads (DBAT), the token is acquired during |
| | DBAT initialization and freed during DBAT |
| | termination. |
+------------------+--------------------------------------------------+
| ACE | The ACE (Agent Control Element) control block |
| | address for the thread that produced the trace |
| | data. |
+------------------+--------------------------------------------------+

XSystem Data Fields


In xsystem data mode, additional data fields are present.
Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| COnt | Invokes the DBTHCONT command to display active |
| | thread contentions for the selected thread. |
+------------------+--------------------------------------------------+
| Select | Invokes the DETAILS command to display |
| | detailed information for the selected |
| | thread. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
DBTHCONT

DBTHCONT Command

The DBTHCONT command displays information about active Db2 thread


contentions.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DBTHCONT | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | If the command supports cross system data |
| | collection, this parameter forces cross system |
| | data collection to be off for this execution, |
| | but the current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Db2 subsystems |
| | on the current system. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of Db2 subsystems to be displayed. The list of |
| | available groups with type DB2SSID can be found |
| | on the GROUPS command. A group name of "*" can |
| | be entered to indicate that no group processing |
| | is required. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| DB2 | The Db2 version if the current address space is |
| | a Db2 address space. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem identifier if the current |
| | address space is a Db2 address space. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | Possible values are: |
| | |
| | REGION - The current target region |
| | SYSTEM - All regions on the current system |
| | XSYSTEM - All regions on all systems |
+------------------+--------------------------------------------------+
| Group | Current DB2SSID group name specified by the |
| | GROUP command parameter. |
| | This entry is displayed only when a group has |
| | been specified. |
+------------------+--------------------------------------------------+

Data Fields

Default Sort Order: XSSystem,A,SSID,A

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DSGroup | The name of the data sharing group that the |
| | Db2 subsytem belongs to. This field is blank if |
| | the subsystem is not a member of a data sharing |
| | group. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem ID that was used to obtain the |
| | active thread contention information. |
+------------------+--------------------------------------------------+
| Subsys | The Db2 subsystem ID that the active thread |
| | belongs to. |
+------------------+--------------------------------------------------+
| Jobname | The job name of the Db2 subsystem. |
+------------------+--------------------------------------------------+
| AuthId | The primary authorization ID of the thread. |
+------------------+--------------------------------------------------+
| CorrId | The correlation ID that is associated with the |
| | thread. |
+------------------+--------------------------------------------------+
| PlanName | Identifies the name of the application plan |
| | specified when using the BIND command under the |
| | DSN processor. For Db2 command threads and |
| | threads in identify status, the plan name is |
| | blank. |
+------------------+--------------------------------------------------+
| Status | Specifies whether this row of data pertains |
| | to the holder or waiter of the resource in |
| | contention. |
| | |
| | Possible values are: |
| | |
| | HOLD Holder of lock |
| | |
| | WAIT Waiting for lock |
+------------------+--------------------------------------------------+
| Elap | The elapsed suspend time since the lock waiter |
| | started waiting for the lock. This column is |
| | populated only for rows where Status is WAIT. |
+------------------+--------------------------------------------------+
| Type | The type of resource that is locked or the |
| | nature of the process that caused the lock. If |
| | this field is blank, it indicates IBM |
| | Serviceability. |
| | |
| | Possible values are: |
| | |
| | DATAPAGE A page lock in a tablespace |
| | |
| | DATABASE A lock on a database descriptor |
| | |
| | PAGESET A lock on a non-partitioned table |
| | space or index space |
| | |
| | DATASET A lock on one of the partitions of |
| | a partitioned table space or index |
| | space |
| | |
| | SKCT A lock on an application plan's |
| | skeleton cursor table |
| | |
| | INDXPAGE A page lock in an index space |
| | |
| | DS_OPEN A lock that serializes dataset |
| | opens and closes |
| | |
| | UTIL_DMG A lock used for utility I/O damage |
| | assessment |
| | |
| | PSET_PC A lock issued on pageset pieces |
| | while a new pageset piece is |
| | allocated |
| | |
| | DBA_TABL A lock on a table, table space, or |
| | database that is being processed |
| | by a CREATE, DROP, or ALTER |
| | statement |
| | |
| | RETRY A lock used for retry during an |
| | abort |
| | |
| | 32K_DESP A 32k desperation pool lock that |
| | occurs as an overflow out of the |
| | 4K buffer pools and implies that |
| | the buffers are undersized |
| | |
| | SYSLGRNG A lock obtained while writing to |
| | the SYSLGRNG table space |
| | |
| | UTILITY A lock that utility jobs use for |
| | serialization |
| | |
| | MASS_DEL A mass delete lock that occurs |
| | when a DELETE is used without a |
| | WHERE clause or a SELECT statement |
| | specifies WITH UR |
| | |
| | TABLE A lock used on a table in a |
| | segmented table space |
| | |
| | HSH_ANCH A hash anchor lock that is used |
| | when accessing Db2 catalog or |
| | directory tables |
| | |
| | SKPT A lock on a skeleton package table |
| | |
| | COLLECT A lock on a package collection |
| | |
| | CS_DRAIN Cursor stability (CS) drain locks |
| | that Db2 commands and utilities |
| | use to serialize CS drains |
| | |
| | RR_DRAIN Repeatable read (RR) drain locks |
| | that Db2 commands and utilities |
| | use to serialize RR drains |
| | |
| | WR_DRAIN Write drain locks that Db2 |
| | commands and utilities use to |
| | serialize write drains |
| | |
| | BINDLOCK Auto/remote bind lock for the |
| | serialization of package lock |
| | autobinds, remote binds, and |
| | remote rebinds |
| | |
| | ROW Row lock |
| | |
| | INDX_EOF Index end-of-file lock |
| | |
| | AL_BPOOL Alter bufferpool locks are used to |
| | serialize ALTER BUFFERPOOL |
| | commands |
| | |
| | SS_GPOOL Group Bufferpool Start/Stop lock |
| | |
| | INDX_PLK Index Manager Tree P-lock |
| | |
| | P/P_PLCK Pageset or Partition P-lock |
| | |
| | PAGE_PLK Page P-lock |
| | |
| | DDF_PLCK Distributed Data Facility CDB |
| | P-lock |
| | |
| | GBP_CAST Group Bufferpool level castout |
| | P-lock |
| | |
| | P/P_CAST Pageset or Partition castout |
| | P-lock |
| | |
| | RLF_PLCK Resource Limit Facility P-lock |
| | |
| | DBD_PLCK Data Base Descriptor P-lock |
| | |
| | CATM_CVD CATMAINT Directory lock |
| | |
| | CATM_CVC CATMAINT Convert Catalog lock |
| | |
| | CATM_MIG Migration lock |
| | |
| | DB_EX_LG Database Exception LPL/GRECP lock |
| | |
| | UTIL_UID Utility UID lock |
| | |
| | UTILEXCL Utility exclusive execution lock |
| | |
| | SCA_REDO SCA access for restart/redo |
| | information lock |
| | |
| | GPDB_EXU Database Exception Update lock |
| | |
| | REPR_DBD REPAIR DBD TEST/DIAGNOSE lock |
| | |
| | DB_CMD_S Database command serialization |
| | |
| | BM_PS_PL Buffer manager pageset RR P-lock |
| | |
| | MX_UNKN IBM Serviceability |
| | |
| | LOB_LOCK Lock on LOB type object |
| | |
| | UTIL_CMT Utility Commit lock |
| | |
| | LPL_RCVR LPL recovery lock |
| | |
| | HDR_HASH Header page hash bucket |
| | |
| | PIT_RCVR System-level point in time |
| | recovery lock |
| | |
| | XML_LOCK Lock on XML type object |
| | |
| | ADD_PART Add partition serialization lock |
| | |
| | SYSENVRL SYSIBM.SYSENVIRONMENT |
| | serialization lock |
| | |
| | UTIL_OBJ Utility object lock |
| | |
| | DBD_LOAD Data Base Descriptor load lock |
| | |
| | CMP_BLD Compress dictionary build lock |
| | |
| | CMP_LOAD Compress dictionary load lock |
| | |
| | HASH_VAL Hash value lock |
| | |
| | INDEXKEY Index key lock |
| | |
| | DGTTURID Unit of Recovery ID lock on |
| | Declared Global Temporary Table |
| | |
| | ACCELCMD Db2 accelerator services command |
| | lock |
| | |
| | UT_OBJ_H Utility object lock with hash |
| | |
| | UTL_CTLG Db2 Utility catalog serial lock |
| | |
| | DYNQHASH SYSIBM.SYSDYNQRY hash ID lock |
| | |
| | DYNQSGRP SYSIBM.SYSDYNQRY stabilization |
| | group lock |
| | |
| | DYNQ_OBJ SYSIBM.SYSDYNQRY object dependency |
| | lock |
| | |
| | UTL_CTLG Db2 Utility catalog serial lock |
| | |
| | DYNQHASH SYSIBM.SYSDYNQRY hash ID lock |
| | |
| | DYNQSGRP SYSIBM.SYSDYNQRY stabilization |
| | group lock |
| | |
| | DYNQ_OBJ SYSIBM.SYSDYNQRY object dependency |
| | lock |
| | |
| | DYNQAUTH SYSIBM.SYSDYNQRY authorization ID |
| | dependency lock |
| | |
| | INMEMFTB In-memory fast traverse block |
| | (FTB) lock |
| | |
| | UNLOCK IRLM LATCH/LOCK wait for unlock to |
| | complete |
| | |
| | CHANGE IRLM LATCH/LOCK change lock |
| | scope/status |
| | |
| | NOTIFY IRLM inter-system communication |
| | |
| | LOCK IRLM internal LATCH/LOCK function |
| | |
| | QUERY IRLM LATCH/LOCK query |
| | |
| | ??? Unknown or serviceability |
+------------------+--------------------------------------------------+
| State | The state the lock is currently in. |
| | |
| | Possible values are: |
| | |
| | ANY Any lock |
| | |
| | IS Intent share |
| | |
| | IX Intent exclusive |
| | |
| | S Share |
| | |
| | U Update |
| | |
| | NSU Non-shared update |
| | |
| | SIX Share intent exclusive |
| | |
| | X Exclusive |
+------------------+--------------------------------------------------+
| Resource | The resource that is held in a lock contention. |
+------------------+--------------------------------------------------+
| ConnName | The name of the connection identified to Db2. |
+------------------+--------------------------------------------------+
| Duration | Specifies when a lock on a resource is |
| | released. |
| | |
| | Possible values are: |
| | |
| | ALLOC Lock is released when the resource |
| | is deallocated. |
| | |
| | COMMIT Lock is released when the |
| | lockholder issues a COMMIT. |
| | |
| | CMMT_1 Locks that are needed to maintain |
| | the position of a cursor are opened |
| | "WITH HOLD". These locks are held |
| | past the commit point. |
| | |
| | MANUAL For plans that were bound with |
| | isolation level CS, Db2 does not |
| | wait until the next commit point |
| | to release locks on pages that were |
| | not updated. |
| | |
| | MANL_1 Temporary change of consistency |
| | level from CS to RR during bind and |
| | DDL (RDS changes back internally). |
| | |
| | PLAN Lock is released when the plan is |
| | deallocated. |
| | |
| | INTRST Duration Interest. |
| | |
| | FREE Duration to free all. |
+------------------+--------------------------------------------------+
| DBID | The database ID of a pageset's database. |
+------------------+--------------------------------------------------+
| OBID | The object identifier of the table/index space |
| | pageset or a table. |
+------------------+--------------------------------------------------+
| PhysLog | Specifies whether this lock is physical or |
| | logical. |
| | |
| | Possible values are: |
| | |
| | Physical Lock is physical |
| | |
| | Logical Lock is logical |
+------------------+--------------------------------------------------+
| ACE | The ACE (Agent Control Element) control block |
| | address of the thread. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Line Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the DETAILS command to display detailed |
| | information for the selected thread. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
DB2

DB2 Command

The DB2 command is used to set the current target DB2 subsystem.

Command Syntax

+---------------+-----------------------------------------------------+
| DB2 | [ ssid | First | Last | Next | Prev ] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| ssid | The name of a DB2 subsystem. |
| | See the DB2LIST command display for a list of |
| | active DB2 subsystems. |
+------------------+--------------------------------------------------+
| First | The first active DB2 subsystem. This is the |
| | default. |
+------------------+--------------------------------------------------+
| Last | The last active DB2 subsystem. |
+------------------+--------------------------------------------------+
| Next | The next active DB2 subsystem. |
+------------------+--------------------------------------------------+
| Prev | The previous active DB2 subsystem. |
+------------------+--------------------------------------------------+

Messages

DB20001E [ssid] [service-name] failed, [reason]

An internal DB2 collection service failed.

[ssid] The DB2 subsystem name.


[service-name] The service name.

DB20002I [dir] connected to agent [agt] on port [port] with socket [socket]

A successful connection was made to XNet agent [agt] using director


ID [dir] on port [port] with socket number [socket]

DB20003I [dir] disconnected from agent [agt] - socket [socket]

The director [dir] connection to XNet agent [agt] was disconnected


from socket number [socket]

DB20004E Agent [agt] request [req] failed - rc [rc] rsn [rsn] - [agtmsg]

A request [req] was sent to agent [agt] and the request


failed with an agent return code of [rc] and reason code
of [rsn]. The [agtmsg] is message data returned from the agent.
DB20005E Agent [agt] request [req] failed - socket closed by peer

A request [req] was sent to agent [agt] and the request


failed. No data was returned indicating that the socket
was closed by the XNet server.

DB20006E Agent [agt] request [req] failed - XNet reason [code] [desc]

A request [req] was sent to agent [agt] and the request


failed with XNet reason [code]. If the reason code is known
[desc] will describe the reason code, otherwise, it is blank.

XNet reason 00000121 - User ID verify error


If this particular reason code has been given, this indicates
that the a valid PassTicket has been generated, but it hasn not
been accepted during User ID/Password validation processing.

Two possible reasons for this are a valid XNET-PassTicketApplId


was specified but it is for a different Xnet subsystem than what
is specified on XNET-Port. Both of these parameters are specified
in SVWLDB2 PARMLIB. A second reason is a valid XNET-PassTicketApplId
was specified but it did not match the Xnet PASSNAME parameter
(as specified in the Xnet configuration).

DB20007I [xmsg]

XNet request failed. [xmsg] is a message that was returned


as part of the reply status.

DB20008E Agent [agt] request [req] Invalid target length [len] for column [col]

A request [req] was sent to agent [agt] and the request response
contained a column [col] that could not be processed because the
target control block field length [len] was not correct.

DB20009E Agent [agt] request [req] Unknown column type [type] for column [col]

A request [req] was sent to agent [agt] and the request response
contained a column [col] that had an unknown column type code of
[type]. The request could not be processed.

DB20010E Agent [agt] request [req] Column type [type] not implemented - column
[col]

A request [req] was sent to agent [Id] and the request response
contained a column [col] that had columnt type of [type] that has not
been implemented.

DB20011I Director [dir] agent [agt] request started

A request was started for director [dir] to agent [agt]

DB20012I Director [dir] agent [agt] request complete

The request for director [dir] to agent [agt] has completed.

DB20013I Elp Tot [1] Ext [2] Int [3]

This is the total external and internal elapsed CPU time used
by the request. External time measures time attributable to the
XNet agent.

DB20014I Cpu Tot [1] Ext [2] Int [3]

This is the total external and internal CPU time used by the
request. External time measures time attributable to the
XNet agent.

DB20015E Agent [Id] request [req] response header too [size] [len]

A request [req] was sent to agent [Id] and the request response
header was invalid because the length [len] was too small or large.

DB20016E Agent [Id] request [req] unknown response ID [resp_id]

A request [req] was sent to agent [Id] and the request response
header contained an unknown response ID [resp_id]

DB20017E Agent [Id] request [req] unexpected response ID [resp_id]

A request [req] was sent to agent [Id] and the request response
header contained an unexpected response ID [resp_id]

DB20018E Agent [Id] request [req] sequence sent [seqsend] sequence returned
[seqret]

A request [req] was sent to agent [Id] and the request response
sequence number [seqret] does not match the sequence number sent
[seqsend].

DB20019E Agent [Id] request [req] response field too small to contain a valid
response [len]

A request [req] was sent to agent [Id] and the request response
is too small to contain a valid response structure. The length is
[len]

DB20020E Agent [Id] request [req] response field revision [rev] not supported

A request [req] was sent to agent [Id] and the request response
field revision number [rev] is not supported.

DB20021E Agent [Id] request [req] response field type [type] unexpected

A request [req] was sent to agent [Id] and the request response
field type code [type] was unexpected.

DB20022E Agent [Id] request [req] response field too small for response packet
header [len]

A request [req] was sent to agent [Id] and the request response
field length [len] is too small to contain a response packet header.

DB20023E Agent [Id] request [req] response packet header contains no segments

A request [req] was sent to agent [Id] and the request response
packet header indicates there are zero segments in the packet.

DB20024E Agent [Id] request [req] unknown response packet type [type]

A request [req] was sent to agent [Id] and the request response
packet type of [type] is unknown.

DB20025E Agent [Id] request [req] query ID sent [idsend] query ID returned
[idret]

A request [req] was sent to agent [Id] and the request response
packet query ID [idret] does not match the sent query ID [idsend].

DB20030I Switched to DB2 [ssid] cpf [cpf] in ASID [asid] job [jobname]

This message indicates that the selected DB2 subsystem is now the
current target subsystem. DB2 commands are always directed to the
SYSVIEW for DB2 agent managing the current target DB2
subsystem.

[ssid] The target DB2's ssid.


[cpf] The target DB2's command prefix.
[asid] The target DB2's address space ID.
[jobname] The target DB2's jobname.

DB20031E No DB2 subsystems found

No DB2 subsystems were found.

DB20032E No active and monitored DB2 subsystem found

While attempting to select a DB2 subsystem, no active DB2 subsystem


was found that was being monitored by a SYSVIEW for DB2 agent.

DB20033E DB2 subsystem [ssid] not [active|monitored|found]

While attempting to select a DB2 subsystem, the DB2 subsystem was


was not found, not active, or not being monitored by a SYSVIEW
for DB2 agent.

DB20034W DB2 not active in ASID [asid] job [jobname]

An attempt to verify the target DB2's asid failed. This can


occur if the target DB2 was stopped or restarted before a
data collection request was completed.

[asid] The address space ID of target DB2 subsystem.


[jobname] The jobname of the target DB2 subsystem.

DB20035W DB2 subsystem [ssid] is not monitored by a SYSVIEW for DB2 agent

This message indicates that the target DB2 subsystem is not being
monitored by a SYSVIEW for DB2 agent. It is possible that Xnet is
not currently running or the DB2 subsystem is connected through a
different Xnet.

DB20036W Agent [agt] request [req] column type [type] for column [col] does
not match expected type [etype]

A request [req] was sent to agent [agt] and the request response
contained a column [col] of type code [type] that did not match
the expected type of [etype]. The column could not be converted,
but conversion continues with the next column.

DB20037W XNET port was not defined. SYSVIEW for DB2 information unavailable
The DB2 component specification is YES however, the XNET port was
not defined using the XNET-Port parameter in the SVWLDB2 parmlib
member. SYSVIEW for DB2 agent status and information cannot be
determined.

DB20038E Agent [agt] request [req] unable to obtain storage length [len] for
XNET reply

A request [req] was sent to agent [agt] and the request response
buffer length of [len] could not be obtained to receive the response.

DB20039I [dir] connection to agent [agt] on socket [socket] is in error

The director [dir] connection to XNet agent [agt] on socket number


[socket] was tested and is in error. The connection will be
disconnected and a reconnect will be attempted.

DB20040W [dir] connection to agent [agt] received an agent notify error

An agent notify error message was received from the agent [agt]
for director ID [dir]. Check for additional messages that follow
for specific reason codes.

DB20041I [action] column type [type] length [len] name [name] data [data]

This is a debug informational message, showing the columns that


were found and the [action] taken.

DB20042I Not all rows were received. More data available.

This is a debug informational message,

DB20043E Generation of the Passticket for access to Xnet failed.


Either the Passticket facility is not available or there
is a definition problem.

Review Passticket setup.

The XNET-PassTicketApplId parameter in the SVWLDB2 PARMLIB member


is the application name to be used to generate user passtickets
to connect to the Database Management Solutions for DB2 for
z/OS Xnet address space.

This XNET-PassTicketApplId name must match the Xnet PASSNAME


parameter in the INITPARM dataset for the Xnet address space.

DB20044E No active thread details available for DB2 subsystem [ssid] ACE [ace]

No detail information was returned for the supplied SSID and ACE
combination, most likely the thread has ended.

DB20045E Agent [agt] request [req] network [function] timed out after [time]
seconds

An attempt to communicate request [req] over the network timed out


after [time] seconds. The TCP function that timed out is identified
by [function].

The XNET session for agent [agt] will be terminated if it has already
been established. An attempt to create a new session will be made
on the next request.
DB2LIST

DB2LIST Command

The DB2LIST command displays information about DB2 address spaces


and subsystems that are currently defined or executing.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DB2LIST | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ GROUP name ] |
| | |
| | [ ALL | MONitored ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| ALL | Displays all DB2 subsystems whether monitored by |
| | a SYSVIEW for DB2 agent or not. |
| | This is the default. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | specifies the group name that contains the list |
| | of DB2 subsystems to be displayed. The list of |
| | available groups with type DB2SSID can be found |
| | on the GROUPS command. |
| | A group name of "*" can be entered to indicate |
| | that no group processing is required. |
+------------------+--------------------------------------------------+
| MONitored | Displays only DB2 subsystems that are monitored |
| | by a SYSVIEW for DB2 agent. |
+------------------+--------------------------------------------------+

Information Fields
+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| DB2 | The Db2 version if the current address space is |
| | a Db2 address space. |
+------------------+--------------------------------------------------+
| SSID | The Db2 subsystem identifier if the current |
| | address space is a Db2 address space. |
+------------------+--------------------------------------------------+
| Group | Current DB2SSID group name specified by the |
| | GROUP command parameter. |
| | This entry is displayed only when a group has |
| | been specified. |
+------------------+--------------------------------------------------+
| XNET Port | Current XNET port specified on the XNET-Port |
| | parameter in the SVWLDB2 PARMLIB member. |
| | |
| | This port value must match the value specified |
| | by the Xnet PORT parameter. A value of 0 |
| | prevents any attempt to connect to the Xnet |
| | address space. |
+------------------+--------------------------------------------------+
| Status | The current connection status. |
| | Possible values are: |
| | |
| | CONNECTED The connection has been made. |
| | |
| | NOTCONNECTED No connection made. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SSID | The DB2 subsystem ID. |
+------------------+--------------------------------------------------+
| Jobname | The name of the job. |
+------------------+--------------------------------------------------+
| Status | The DB2 master address space status. Valid |
| | values are: |
| | |
| | ACTIVE The DB2 master is active |
| | INACTIVE The DB2 master is not active |
| | QUIESCE The DB2 master is quiescing |
| | FORCE The DB2 master is stopping with |
| | a MODE(FORCE) |
| | |
| | In XSYS mode, this field is only valid at |
| | SYSVIEW 13.5 and above. |
+------------------+--------------------------------------------------+
| Mon | Indicates whether or not the DB2 subsystem is |
| | being monitored by SYSVIEW for DB2. Valid |
| | values are: |
| | |
| | MON The DB2 subsystem is being monitored |
| | by SYSVIEW for DB2 and an XNET |
| | agent was found, |
| | |
| | blank Either SYSVIEW for DB2 is not |
| | monitoring the DB2 subsystem or |
| | a SYSVIEW for DB2 XNET agent could |
| | not be located. |
| | |
| | In XSYS mode, this field is only valid at |
| | SYSVIEW 13.5 and above. |
+------------------+--------------------------------------------------+
| Conn | The status of the connection to the SYSVIEW |
| | for DB2 XNET agent. Valid values are: |
| | |
| | blank The user session has not connected to |
| | the agent, or no agent is available. |
| | A connection will only be attempted |
| | when a DB2 command is issued that |
| | requires a connection. |
| | |
| | CONN The user session has a connection to |
| | the SYSVIEW for DB2 XNET agent for |
| | this DB2 subsystem. |
| | |
| | In XSYS mode, this field is only valid at |
| | SYSVIEW 13.5 and above. |
+------------------+--------------------------------------------------+
| Version | The DB2 version. |
+------------------+--------------------------------------------------+
| Cpf | The command prefix. |
+------------------+--------------------------------------------------+
| Atch | The data sharing group attach name where this |
| | DB2 is a member. The attach name is blank if the |
| | DB2 is not a member of a data sharing group. |
+------------------+--------------------------------------------------+
| DSGroup | The data sharing group name where this DB2 is a |
| | member. The group is blank if the DB2 is |
| | not a member of a data sharing group, or the |
| | group name could not be determined because no |
| | other DB2 in the same group was active on the |
| | system. |
+------------------+--------------------------------------------------+
| Dispatch | The dispatchability of the address space. |
| | Possible values are: |
| | |
| | RUNNING - The address space has one or more |
| | units of work (tasks or SRBs) |
| | running on a processor. |
| | |
| | READYnnn - The address space has one or more |
| | units of work (tasks or SRBs) that |
| | are dispatchable but are waiting |
| | to run on a processor. The "nnn" |
| | portion is the dispatch priority |
| | order up to a maximum of 255. |
| | |
| | blank - The address space is not |
| | dispatchable. |
+------------------+--------------------------------------------------+
| JobStat | The status of the job. Valid values are: |
| | |
| | NS Nonswappable |
| | LSW Logically swapped |
| | GO OUT Currently being swapped out |
| | GO IN Currently being swapped in |
| | IN Swapped in |
| | OUT TO Swapped out--terminal output wait |
| | OUT TI Swapped out--terminal input wait |
| | OUT LW Swapped out--long wait |
| | OUT XS Swapped out--auxiliary storage |
| | shortage |
| | OUT RS Swapped out--real storage shortage |
| | OUT DW Swapped out--detected wait |
| | OUT RQ Swapped out--requested swap |
| | OUT NQ Swapped out--enqueue exchange swap |
| | OUT EX Swapped out--exchange on recommended |
| | value |
| | OUT US Swapped out--unilateral swap |
| | OUT TS Swapped out--transition swap |
| | OUT IC Swapped out--improve central storage |
| | OUT IP Swapped out--improve system paging |
| | OUT MR Swapped out--make room |
| | OUT AW Swapped out--APPC wait |
| | OUT OI Swapped out--input wait |
| | OUT OO Swapped out--output wait |
| | OUT LS Swapped out--logical swap |
| | OUT LF Swapped out--logical swap fail |
| | OUT SR Swapped out--real swap |
| | blank No address space found with the |
| | specified jobname |
+------------------+--------------------------------------------------+
| CPUTime | The accumulated CPU time (in CPU seconds) used |
| | by the job. |
+------------------+--------------------------------------------------+
| RealStg | The amount of real storage the job is using in |
| | the private region. |
+------------------+--------------------------------------------------+
| IOCount | The number of I/O operations performed by the |
| | job. |
+------------------+--------------------------------------------------+
| Clocktime | The amount of wall clock time the job has been |
| | executing. |
+------------------+--------------------------------------------------+
| Type | The type of job. Valid values are: |
| | |
| | JOB - A batch job |
| | STC - A started task |
+------------------+--------------------------------------------------+
| Jobnr | The job number. |
+------------------+--------------------------------------------------+
| Stepname | The current stepname. Stepnames are displayed |
| | only for jobs that have a stepname coded in the |
| | JCL. |
+------------------+--------------------------------------------------+
| Procname | The current procedure stepname. Procedure |
| | stepnames are displayed only for jobs that use a |
| | PROC statement in the JCL. |
+------------------+--------------------------------------------------+
| JobClass | The job input class. |
+------------------+--------------------------------------------------+
| ASID | The hexadecimal address space ID. |
+------------------+--------------------------------------------------+
| ASCB | The ASCB address for the job. |
+------------------+--------------------------------------------------+
| JobReq | Indicates if the job has been defined as a job |
| | that is required to be active. |
| | |
| | Possible values are: |
| | blank - job is not required to be active |
| | JOBREQ - job is required to be active |
| | |
| | Required jobs can be defined via the MONRULES |
| | command. |
| | |
| | Metric Exclude RsceScope |
| | MVS_JOB_Status INCLUDE jobname |
| | |
+------------------+--------------------------------------------------+
| Description | A description of the address space based on the |
| | jobname. The description for a jobname is |
| | defined in the JOBNAMES parmlib member. |
+------------------+--------------------------------------------------+
| XnetDirId | The XNET director ID value for the connection to |
| | the SYSVIEW for DB2 XNET agent. |
| | |
| | In XSYS mode, this field is only valid at |
| | SYSVIEW 13.5 and above. |
+------------------+--------------------------------------------------+
| XnetSock | The XNET director TCP socket number for the |
| | connection to the SYSVIEW for DB2 XNET agent. |
| | |
| | In XSYS mode, this field is only valid at |
| | SYSVIEW 13.5 and above. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the ASID command for the selected |
| | jobname. |
+------------------+--------------------------------------------------+
| STArt | Invokes the MVS command START DB2 using the |
| | command prefix (Cpf) for this DB2 subsystem. |
+------------------+--------------------------------------------------+
| STOP | Invokes the XMVS command STOP DB2 MODE(QUIESCE) |
| | using the command prefix (Cpf) for this DB2 |
| | subsystem. |
+------------------+--------------------------------------------------+
| STOPFOR | Invokes the XMVS command STOP DB2 MODE(FORCE) |
| | using the command prefix (Cpf) for this DB2 |
| | subsystem. |
+------------------+--------------------------------------------------+
Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| COnt | Invokes the DBTHCONT command to display any |
| | active thread contentions for the DB2 SSID. |
+------------------+--------------------------------------------------+
| IPLIsten | Invokes the IPLISTEN command for IP server jobs |
| | whose name contains the DB2 SSID. |
+------------------+--------------------------------------------------+
| IPTconn | Invokes the IPTCONN command for IP server jobs |
| | whose name contains the DB2 SSID. |
+------------------+--------------------------------------------------+
| IRlm | Invokes the IRLMLIST command for the selected |
| | DB2 SSID. |
+------------------+--------------------------------------------------+
| INTerval | Invokes the DETAILS DBSYSSUM command for the |
| | selected DB2 SSID. Data displayed represents the |
| | last data collection interval. |
+------------------+--------------------------------------------------+
| LISTFILE | Invokes the LISTFILE command for the selected |
| LF | jobname. |
+------------------+--------------------------------------------------+
| JJobque | Invokes the JJOBQUE command for the selected |
| LJ | jobname. |
+------------------+--------------------------------------------------+
| LOcks | Invokes the IRLMLOCK command for the selected |
| | DB2 SSID. |
+------------------+--------------------------------------------------+
| SUMmary | Invokes the DETAILS DBSYSSUM command for the |
| | selected DB2 SSID. Data displayed represents the |
| | last data collection interval. |
+------------------+--------------------------------------------------+
| TOTal | Invokes the DETAILS DBSYSSUM command for the |
| | selected DB2 SSID. Data displayed represents |
| | totals since the Db2 subsystem was started. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refreshes display data. |
+------------------+--------------------------------------------------+
DCACAREA

DCACAREA Command

The DCACAREA command displays Multi-User-Facility access areas for


Datacom address spaces.

Command Syntax

+------------------+--------------------------------------------------+
| DCACAREA | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| MUFname | The Multi-User-Facility name. |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| Area | The name of the area. |
+------------------+--------------------------------------------------+
| Access | Access in effect. |
+------------------+--------------------------------------------------+
| UserSet | Access per user set. |
+------------------+--------------------------------------------------+
| Utility | Access per DBUTLTY. |
+------------------+--------------------------------------------------+
| UtilName | Utility name if any. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCACCESS

DCACCESS Command

The DCACCESS command displays Multi-User-Facility start option


ACCESS settings.

Command Syntax

+------------------+--------------------------------------------------+
| DCACCESS | [ dbid ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DBID | The request database ID. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DBID | The database ID. |
+------------------+--------------------------------------------------+
| Access | This field contains the type of access allowed |
| | for User Requirements Table (URT) opens. Valid |
| | values are: |
| | |
| | OFF No opens are allowed |
| | READ Opens are allowed if UPDATE=NO |
| | WRITE All opens are allowed |
+------------------+--------------------------------------------------+
| Status | This field contains the current open status of |
| | the database. Valid values are: |
| | |
| | CLOSED Database has no opened tables |
| | READ Database has opened tables and all |
| | were opened with UPDATE=NO |
| | WRITE Database has opened tables and at |
| | least one was opened with |
| | UPDATE=YES |
+------------------+--------------------------------------------------+
| Maint | Specifies whether maintenance can currently be |
| | done to this database. |
+------------------+--------------------------------------------------+
| Optimize | Specifies whether the OPTIMIZE Multi-user |
| | start-up option is set for this database ID. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the DCAREAS command for the selected |
| | database. |
+------------------+--------------------------------------------------+
| Areas | Invokes the DCAREAS command for the selected |
| | database. |
+------------------+--------------------------------------------------+
| DSets | Invokes the DCDSETS command for the selected |
| | database. |
+------------------+--------------------------------------------------+
| IO | Invokes the DCAREAIO command for the selected |
| | database. |
+------------------+--------------------------------------------------+
| Tables | Invokes the DCTABLES command for the selected |
| | database. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCACNT

DCACNT Command

The DCACNT command displays the accounting facility. It provides


startup information as well as the current information about each
accounting table.

Command Syntax

+------------------+--------------------------------------------------+
| DCACNT | [ dbid ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DBID | The request database ID. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DBID | The database ID. |
+------------------+--------------------------------------------------+
| Table | The name of the accounting table. |
+------------------+--------------------------------------------------+
| Status | The status of the current accounting table. |
| | Valid values are: |
| | |
| | OPEN Accounting table is open |
| | CLOSED Accounting table is closed |
+------------------+--------------------------------------------------+
| Buffer | The size of the buffer as provided in the |
| | startup option. |
+------------------+--------------------------------------------------+
| Thresh | The current value of the threshold counter. |
| | This defines how long changes to an accounting |
| | table can be buffered in the accounting buffer |
| | before being spilled to the normal buffers. |
+------------------+--------------------------------------------------+
| Requests | The number of times this accounting table was |
| | used. |
+------------------+--------------------------------------------------+
| IOCount | The physical I/O (EXCPs) issued for the |
| | accounting table. |
+------------------+--------------------------------------------------+
| Locates | The number of entries retrieved into the |
| | accounting buffers including existing entries in |
| | the accounting table with reclaimed internal |
| | space. |
+------------------+--------------------------------------------------+
| Adds | The number of adds that were done to this |
| | accounting table. |
+------------------+--------------------------------------------------+
| Updates | The number of times that records in the |
| | accounting table were updated. |
+------------------+--------------------------------------------------+
| Unavail | The number of user application requests that |
| | have to wait due to insufficient memory |
| | allocated by the buffer parameter. |
+------------------+--------------------------------------------------+
| Conflicts | The number of entries in the accounting table |
| | that had exclusive control held by a user |
| | application when a spill was initiated. |
+------------------+--------------------------------------------------+
| Skipped | The number of entries that were not immediately |
| | processed due to exclusive control conflicts. |
+------------------+--------------------------------------------------+
| Entries | The number of entries in the in-memory |
| | accounting buffer. |
+------------------+--------------------------------------------------+
| Reclaim | The number of in-memory table entries reused |
| | after a spill, that is, the number of entries |
| | for which a LOCATE was not required. |
+------------------+--------------------------------------------------+
| LocStart | The number of times that a group of locates were |
| | performed for the accounting table. |
+------------------+--------------------------------------------------+
| SpillThrsh | The number of times that the threshold parameter |
| | value was exceeded and a spill was done. |
+------------------+--------------------------------------------------+
| SpillInt | The number of spills initiated to increase the |
| | number of entries available. |
+------------------+--------------------------------------------------+
| Spill | Specifies whether this accounting table is |
| | currently being spilled. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCAREAIO

DCAREAIO Command

The DCAREAIO command displays read and write request statistics


for each area. This command can display request information
since the Multi-User-Facility has started or the current interval.

Command Syntax

+------------------+--------------------------------------------------+
| DCAREAIO | [ dbid ] [ Total | Interval | Sample ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+
| Interval | Display values for the interval. |
+------------------+--------------------------------------------------+
| Total | Display values as totals since the MUF started. |
+------------------+--------------------------------------------------+
| Sample | Display values as totals since the MUF started |
| | on the initial display. On each refresh, |
| | display interval values. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DBID | The request database ID. |
+------------------+--------------------------------------------------+
| Interval | The elapsed time interval for the "Current" |
| | value. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DBID | The database ID for a data area or the index to |
| | a data area. It is zero for the Directory and |
| | Log areas. |
+------------------+--------------------------------------------------+
| Area | The area name. This includes the Directory |
| | (CXX), Log areas (LXX/NXX), indices (IXX), and |
| | user data areas. |
+------------------+--------------------------------------------------+
| L-Reads | A logical read of any block in this area. A |
| | Directory, log, index, or data block having been |
| | physically read from DASD can stay in memory |
| | and be used over and over again. Each of these |
| | uses is a logical read. |
+------------------+--------------------------------------------------+
| L-Writes | A logical write of any block in the area. An |
| | add, update, or delete of a record generates one |
| | logical write to the data area. |
+------------------+--------------------------------------------------+
| P-Reads | The number of I/O requests made against this |
| | area to read one or more blocks of DASD |
| | information. |
+------------------+--------------------------------------------------+
| P-Writes | The number of I/O requests made against this |
| | area to write one or more blocks of DASD |
| | information. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the DCTABLES command for the current |
| | dbid and area. |
+------------------+--------------------------------------------------+
| Areas | Invokes the DCAREAS command for the current |
| | dbid and area. |
+------------------+--------------------------------------------------+
| DSets | Invokes the DCDSETS command for the current |
| | dbid and area. |
+------------------+--------------------------------------------------+
| Tables | Invokes the DCTABLES command for the current |
| | dbid and area. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| OPTions | Set and display command options. |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC |
| | variable. The variable created or updated is |
| | named SYSV_OPTIONS_DCAREAIO. EXTRACT is |
| | only valid when the product is running under a |
| | TSO CLIST or REXX EXEC. EXTRACT can be |
| | specified alone or in combination with any other |
| | OPTIONS keywords. |
+------------------+--------------------------------------------------+

OPTIONS Subcommand

Use the OPTIONS subcommand to set and display processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [options] |
+---------------+-----------------------------------------------------+

OPTIONS Parameter Values

The following table lists and explains the valid OPTIONS parameter
values. Any number of the values can be specified in any order.
The current settings of all options are always be displayed in
response to the OPTIONS subcommand.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| Interval | Display values for the interval. |
+---------------+-----------------------------------------------------+
| Total | Display values as totals since the MUF started. |
+---------------+-----------------------------------------------------+
| Sample | Display values as totals since the MUF started |
| | on the initial display. On each refresh, display |
| | interval values. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_DCAREAIO. This keyword is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. The EXTRACT keyword can be |
| | specified alone or in combination with any other |
| | OPTIONS keyword. |
+---------------+-----------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCAREAS

DCAREAS Command

The DCAREAS command displays an entry for each area in the Directory
(CXX).

Command Syntax

+------------------+--------------------------------------------------+
| DCAREAs | [ dbid ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DBID | The request database ID. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| Area | The name of the area. |
+------------------+--------------------------------------------------+
| Occurrence | The Datadictionary entity-occurrence name of |
| | this area. |
+------------------+--------------------------------------------------+
| Inserts | Specifies that the counter is set to zero during |
| | a LOAD. It is incremented by one each time a |
| | row is inserted by either SQL or RAAT into a |
| | table in this area. |
+------------------+--------------------------------------------------+
| HiURI | If this area has no loaded table, or if it was |
| | loaded with URI=NO, then this field is undefined |
| | and set to null. For URI, each row in an area |
| | is assigned a Unique Row Identifier when it is |
| | added or when it is LOADed except for a LOAD |
| | from a RECID=YES BACKUP. HiURI is the last |
| | assigned number. |
+------------------+--------------------------------------------------+
| Moved | The number of moved records. Records are moved |
| | during an update to a compressed table where the |
| | size of stored data is larger and does not fit |
| | in the data block. The counter is set to zero |
| | during a load. The counter is only an |
| | indication of the volume of moved records and |
| | can range from 0 to 65535. You can use this |
| | value to help tune SLACK either in the LOAD |
| | utility or in the definition of the area in |
| | Datadictionary. You can also use it to |
| | determine if a reorganize is desirable. |
+------------------+--------------------------------------------------+
| Slack | Contains the value of SLACK to reserve space in |
| | a data block when inserting records. The value |
| | is provided through Datadictionary in the area |
| | definition. It does NOT relate to the SLACK |
| | that can be specified during the LOAD function |
| | of DBUTLTY. |
+------------------+--------------------------------------------------+
| SQLName | The name defined to SQL. |
+------------------+--------------------------------------------------+
| Dataspace | The dataspace option. Valid values are: |
| | |
| | NONE No reclamation |
| | RANDOM Random reuse |
| | WRAP Wrap sequential reuse |
| | CLUSTER Clustering reuse |
| | RANDOM-OLR Random reuse with OLREORG support |
| | WRAP-OLR Wrap sequential reuse with OLREORG |
| | support |
+------------------+--------------------------------------------------+
| Extend | Specifies whether dynamic extends are allowed |
| | for this area. |
+------------------+--------------------------------------------------+
| ExtType | Contains the type of value specified for |
| | dynamic extend. Valid values are: |
| | |
| | CYL Cylinders |
| | TRK Tracks |
+------------------+--------------------------------------------------+
| ExtVal | The number of tracks or cylinders to request if |
| | dynamic extend is selected. It contains a zero |
| | if dynamic extend is not selected. When dynamic |
| | extend is selected, tracks or cylinders specified|
| | here (if not zero) are used during each dynamic |
| | extend. If the value is zero, then the VTOC |
| | JCL secondary allocation is used. This field is |
| | not used during the extend in DBUTLTY. |
+------------------+--------------------------------------------------+
| URI | The URI status for an area with no loaded tables |
| | is considered unknown and is null. If a loaded |
| | table exists, the area is URI or blank. |
+------------------+--------------------------------------------------+
| Load | Specifies whether the area is currently being |
| | loaded. |
+------------------+--------------------------------------------------+
| Unload | Specifies whether the area is currently being |
| | unloaded. |
+------------------+--------------------------------------------------+
| LoadDate | The date of area load if any table in the area |
| | is loaded. If there are no loaded tables in |
| | the area, then this field is blank. |
+------------------+--------------------------------------------------+
| LoadTime | The time of area load if any table in the area |
| | is loaded. If there are no loaded tables in the |
| | area, then this field is blank. |
+------------------+--------------------------------------------------+
| VerDD | The version of the Datadictionary occurrence of |
| | this area. |
+------------------+--------------------------------------------------+
| Status | The status of the occurrence. |
+------------------+--------------------------------------------------+
| LinkOpt | Specifies whether the CXX link option is in place|
| | for this data area. The CXX link option provides |
| | an edit to assure an area is being accessed |
| | through the correct directory. Valid values are |
| | YES and NO. |
+------------------+--------------------------------------------------+
| BinSrch | Specifies whether this data area uses the binary |
| | search option algorithm. Single table areas that |
| | do not use compression, and that have a |
| | sufficient number of possible rows per block, |
| | use a binary search algorithm for speed. |
| | Valid values are YES and NO. |
+------------------+--------------------------------------------------+
| URIReus | Contains the value specified for the URI-REUSE |
| | attribute. Valid values are YES and NO. |
| | |
| | This field is valid starting with Datacom r15.0. |
+------------------+--------------------------------------------------+
| TVer | Contains the table version (generation level) |
| | of the table. |
| | |
| | This field is valid starting with Datacom r15.0. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the DCTABLES command for the current |
| | dbid and area. |
+------------------+--------------------------------------------------+
| DSets | Invokes the DCDSETS command for the current |
| | dbid and area. |
+------------------+--------------------------------------------------+
| IO | Invokes the DCAREAIO command for the current |
| | dbid and area. |
+------------------+--------------------------------------------------+
| Tables | Invokes the DCTABLES command for the current |
| | dbid and area. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCBUFCON

DCBUFCON Command

The DCBUFCON command displays information when a DBID or DBID and


area have been defined to use an alternate buffer pool. The
displayed data is from the MUF_BUF_CONTENT dynamic system table.

Command Syntax

+------------------+--------------------------------------------------+
| DCBUFCON | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| MufName | The Multi-User-Facility name. |
+------------------+--------------------------------------------------+
| DBID | The database Identifier. |
+------------------+--------------------------------------------------+
| Area | Datacom name of the area if the buffer pool |
| | content was set at the area level. If the buffer |
| | pool content was set at the database level, the |
| | value is blanks. |
+------------------+--------------------------------------------------+
| Pool | The name of the alternate buffer pool this |
| | entity is using. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCBUFFER

DCBUFFER Command

The DCBUFFER command displays system statistics concerning buffer


usage. This command can display request information since the
Multi-User-Facility has started or the current interval.

Command Syntax

+------------------+--------------------------------------------------+
| DCBUFFER | [ Count | PErcent ] [ Total | Interval | Sample ]|
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| PERCENT | Display use counts as percentages of the total. |
+------------------+--------------------------------------------------+
| COUNT | Display use counts as counter values. |
+------------------+--------------------------------------------------+
| Interval | Display values for the interval. |
+------------------+--------------------------------------------------+
| Total | Display values as totals since the MUF started. |
+------------------+--------------------------------------------------+
| Sample | Display values as totals since the MUF started |
| | on the initial display. On each refresh, |
| | display interval values. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Interval | The elapsed time interval for the "Current" |
| | value. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Buffer | Specifies the buffer type. |
+------------------+--------------------------------------------------+
| Use-1 | The number of times a buffer was referenced "n" |
| Use-2 | times after the buffer was read from DASD or |
| Use-3 | copied from MRDF. |
| Use-4 | |
| Use-5+ | |
+------------------+--------------------------------------------------+
| Sequence | The number of times the buffer was referenced. |
| | |
| | This is not available for buffer type DATA2. |
+------------------+--------------------------------------------------+
| Split | Specifies the number of times that an index |
| | block was split. This indicates growth of an |
| | index. |
| | |
| | This is only valid for buffer types IXX and DXX. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| OPTions | Set and display command options. |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC |
| | variable. The variable created or updated is |
| | named SYSV_OPTIONS_DCBUFFER. EXTRACT is |
| | only valid when the product is running under a |
| | TSO CLIST or REXX EXEC. EXTRACT can be |
| | specified alone or in combination with any other |
| | OPTIONS keywords. |
+------------------+--------------------------------------------------+

OPTIONS Subcommand

Use the OPTIONS subcommand to set and display processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [options] |
+---------------+-----------------------------------------------------+

OPTIONS Parameter Values

The following table lists and explains the valid OPTIONS parameter
values. Any number of the values can be specified in any order.
The current settings of all options are always displayed in
response to the OPTIONS subcommand.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| PErcent | Display use counts as percentages of the total. |
+---------------+-----------------------------------------------------+
| Count | Display use counts as counter values. |
+---------------+-----------------------------------------------------+
| Interval | Display values for the interval. |
+---------------+-----------------------------------------------------+
| Total | Display values as totals since the MUF started. |
+---------------+-----------------------------------------------------+
| Sample | Display values as totals since the MUF started on |
| | the initial display. On each refresh, display |
| | interval values. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_DCBUFFER. This keyword is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. The EXTRACT keyword can be |
| | specified alone or in combination with any other |
| | OPTIONS keyword. |
+---------------+-----------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCBUFP

DCBUFP Command

The DCBUFP command displays the MUF_BUF_USE Dynamic System table which
contains information for the buffer pools defined to the Multi-User
Facility.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax
+------------------+--------------------------------------------------+
| DCBUFP | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | [ XSGroup name ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+
Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | |
| | This value can be also be set by issuing the |
| | SET DCMODE REGION command. |
| | |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Datacom address |
| | spaces on the current system. |
| | |
| | This value can also be set by issuing the |
| | SET DCMODE SYSTEM command. |
| | |
| | The current XSDATA profile setting for the |
| | command is honored. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSYStem | Display data for all Datacom address spaces for |
| XSData | all systems. This forces cross system data |
| | collection to be set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Jobname of the Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| MUFName | Name of the Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| PoolName | The name of the standard or alternate index pool.|
| | The standard pools are: DATA, DATA_2, DXX, IXX. |
+------------------+--------------------------------------------------+
| BufSz | Specifies the buffer size for this pool. |
+------------------+--------------------------------------------------+
| Count | Current count of buffers currently specified for |
| | this pool. For the standard buffer pools, the |
| | count includes any FLEXPOOL buffers currently |
| | specified. |
+------------------+--------------------------------------------------+
| Use-1 | Number of times a buffer in this pool was |
| | referenced for the first time, after the buffer |
| | was read from DASD or copied from MRDF. |
+------------------+--------------------------------------------------+
| Use-1% | Percentage of times a buffer in this pool was |
| | referenced for the first time, after the buffer |
| | was read from DASD or copied from MRDF. |
+------------------+--------------------------------------------------+
| Use-2 | Number of times a buffer in this pool was |
| | referenced for a second time, after the buffer |
| | was read from DASD or copied from MRDF. |
+------------------+--------------------------------------------------+
| Use-2% | Percentage of times a buffer in this pool was |
| | referenced for a second time, after the buffer |
| | was read from DASD or copied from MRDF. |
+------------------+--------------------------------------------------+
| Use-3 | Number of times a buffer in this pool was |
| | referenced for a third time, after the buffer |
| | was read from DASD or copied from MRDF. |
+------------------+--------------------------------------------------+
| Use-3% | Percentage of times a buffer in this pool was |
| | referenced for a third time, after the buffer |
| | was read from DASD or copied from MRDF. |
+------------------+--------------------------------------------------+
| Use-4 | Number of times a buffer in this pool was |
| | referenced for a fourth time, after the buffer |
| | was read from DASD or copied from MRDF. |
+------------------+--------------------------------------------------+
| Use-4% | Percentage of times a buffer in this pool was |
| | referenced for a fourth time, after the buffer |
| | was read from DASD or copied from MRDF. |
+------------------+--------------------------------------------------+
| Use-5+ | Number of times a buffer in this pool was |
| | referenced for a fifth time (and a sixth time, |
| | and a seventh time, and so on), after the buffer |
| | was read from DASD or copied from MRDF. |
+------------------+--------------------------------------------------+
| Use-5+% | Percentage of times a buffer in this pool was |
| | referenced for a fifth time (and a sixth time, |
| | and a seventh time, and so on), after the buffer |
| | was read from DASD or copied from MRDF. |
+------------------+--------------------------------------------------+
| Ratio | The ratio of Use-5+ to Use-1 buffer references. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCCBS

DCCBS Command

The DCCBS command displays the MUF_CBS Dynamic System table which
contains Compound Boolean Selection (CBS) information and statistics.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax
+------------------+--------------------------------------------------+
| DCCBS | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | [ XSGroup name ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+
Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | |
| | This value can be also be set by issuing the |
| | SET DCMODE REGION command. |
| | |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Datacom address |
| | spaces on the current system. |
| | |
| | This value can also be set by issuing the |
| | SET DCMODE SYSTEM command. |
| | |
| | The current XSDATA profile setting for the |
| | command is honored. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSYStem | Display data for all Datacom address spaces for |
| XSData | all systems. This forces cross system data |
| | collection to be set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Jobname of the Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| MUFName | Name of the Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| MemUsed | The amount of memory being used for open set |
| | definitions. |
+------------------+--------------------------------------------------+
| MemMax | The maximum amount of memory used for open set |
| | definitions. The maximum amount of memory used is|
| | limited by the CBS specification. If this limit |
| | is reached, open sets must be spilled to the CBS |
| | index. |
+------------------+--------------------------------------------------+
| BufUsed% | This is the percentage of the CBS buffer size |
| | specification currently being used for open set |
| | definitions. |
+------------------+--------------------------------------------------+
| BufMax% | This is the high water percentage of the CBS |
| | buffer size specification that was used for open |
| | set definitions. Once the CBS buffer percent used|
| | reaches 100, it causes the least recently used |
| | sets to be spilled to the CBS index. |
+------------------+--------------------------------------------------+
| Processed | Specifies the number of sets processed by CBS. |
+------------------+--------------------------------------------------+
| DelAge | The number of open sets in the CBS buffer that |
| | were deleted because of the CBS max age |
| | specification. If this number is not zero, it |
| | can indicate that applications are not releasing |
| | sets when they are finished with them. |
+------------------+--------------------------------------------------+
| Spilled | Count of sets which had to be paged to the CBS |
| | index. This is an interaction between the |
| | specified CBS buffer size and the number and size|
| | of open CBS sets. If Spilled is not zero, you |
| | might want to increase the CBS buffer size or |
| | examine your applications for missing SELPR |
| | commands. |
+------------------+--------------------------------------------------+
| Fetched | Count of the number of times a spilled set was |
| | referenced, in order to retrieve more rows. The |
| | ratio between sets spilled and sets fetched can |
| | be used to understand if sets that are truly in |
| | use are being spilled to the CBS index, or if it |
| | is an absence of the SELPR command in user |
| | programs that is causing sets which are no longer|
| | in use to be paged out. |
+------------------+--------------------------------------------------+
| TmpIdx | The number of sets requiring a temporary index. |
+------------------+--------------------------------------------------+
| TmpIdxEnt | The total number of temporary index entries built|
| | to support set selection criteria. |
+------------------+--------------------------------------------------+
| SpillJob | This is the job name that owned the most recently|
| | paged-out set, because the CBS buffer was full. |
| | If no sets have been spilled, this column is |
| | null. |
+------------------+--------------------------------------------------+
| SpillUIB | This is the 32 UIB associated with the most |
| | recently paged-out set, because the CBS buffer |
| | was full. If no sets have been spilled, this |
| | column is null. |
+------------------+--------------------------------------------------+
| Elapsed | The duration or length of time the most recently |
| | spilled set existed before it was spilled in the |
| | format mmm:ss. If no sets have been spilled, this|
| | column is null. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCCBSO

DCCBSO Command

The DCCBSO command displays the MUF_CBS_OLD_SETS Dynamic System


table which contains a row for each of the ten oldest Compound
Boolean Selection (CBS) sets that reside in the CBS buffer and
therefore have not been spilled. There can be fewer than ten rows
in this table if there are currently less than ten sets in the CBS
buffer. The same set can appear more than once in this table if
the set is used while your query is running and after its use is
in the ten least recently used sets.

Command Syntax

+------------------+--------------------------------------------------+
| DCCBSO | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| MUFName | Name of the Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| JobName | The name of the job that opened this set. |
+------------------+--------------------------------------------------+
| SeqNum | A sequence number from one to 10. |
+------------------+--------------------------------------------------+
| SetNum | This is a sequence number assigned when a set is |
| | created. For example, a number of 110 represents |
| | the one hundred and tenth set created during the |
| | life of this MUF. |
+------------------+--------------------------------------------------+
| RunUnit | The internal run unit assigned to the job that |
| | opened this set. |
+------------------+--------------------------------------------------+
| SetAge | The amount of time that has passed since this |
| | set was last used, in the format mmm:ss. |
+------------------+--------------------------------------------------+
| UIB | User Information Block. The User Information |
| | Block associated with this set. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCCDC

DCCDC Command

The DCCDC command displays the MUF_CDC Dynamic System table which
contains information about Change Data Capture (CDC) and the current
Multi-User Facility (MUF).

Command Syntax

+------------------+--------------------------------------------------+
| DCCDC | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| MUFName | Name of the Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| MUFPlex | The name of the group, when running full Data |
| | Sharing as a Mufplex. |
+------------------+--------------------------------------------------+
| BufSz | The CDC work buffer size, taken from the size |
| | parameter of the CDC Multi-User startup option. |
+------------------+--------------------------------------------------+
| MntPolCt | At the time of the last CDCM poll, this is the |
| | count of MNT table records based upon the rows |
| | in the table returned from either a CNTTB or |
| | CNTKY command. |
+------------------+--------------------------------------------------+
| TSNPolCt | At the time of the last CDCM poll, this was the |
| | count of TSN table records based upon the rows |
| | in the table returned from either a CNTTB or |
| | CNTKY command. |
+------------------+--------------------------------------------------+
| DBID | The database identifier (database ID) for the |
| | CDC database, taken from the CDCM_DBID Multi-User|
| | startup option (or default). |
+------------------+--------------------------------------------------+
| PollSec | The interval in seconds, as specified with the |
| | CDCM_POLL Multi-User startup option, between |
| | subsequent checkings (by the subtask) of the |
| | target MUF, to determine the status of the CDCL |
| | and CDCU programs. |
+------------------+--------------------------------------------------+
| WarnSec | Identifies how many seconds, as specified with |
| | the CDCM_WARN Multi-User startup option, that the|
| | CDCL or CDCU program can fall behind the LXX |
| | before a warning message is issued. The CDCL task|
| | is measured from the last log record it saw |
| | compared to the current last log record on DASD. |
| | The CDCU task is measured from the oldest TSN |
| | record in the CDC database to the current last |
| | log record on DASD. |
+------------------+--------------------------------------------------+
| CTRLId | Identifies to the CDC monitor, as specified with |
| | the CDCM_ID Multi-User startup option, which |
| | level of support is being used by the CDCL task. |
| | This information is used in the CNTKR commands to|
| | track the correct records. The letter A is the |
| | valid control ID. |
+------------------+--------------------------------------------------+
| MntReqs | Count of maintenance requests defined as subject |
| | to CDC during the physical life of this MUF |
+------------------+--------------------------------------------------+
| LastCP | The time, given in minutes mm and seconds ss, |
| | that CDCL is behind in processing LXX records. |
| | If the time is greater than 999 minutes, the |
| | display shows +++:++. If the CDCM subtask has |
| | not yet successfully opened the CDCL, the time |
| | is technically unknown and is therefore indicated|
| | by UNKN. |
+------------------+--------------------------------------------------+
| LastLXX | The time, given in minutes mm and seconds ss, |
| | that CDCU is behind in processing TSN records. |
| | If the time is greater than 999 minutes, the |
| | display shows +++:++. If the CDCU user task has |
| | not yet started, the time is technically unknown |
| | and is therefore indicated by UNKN. |
+------------------+--------------------------------------------------+
| ErrTxt | Is set to null if the CDCM task last request |
| | returned a blanks return code. Otherwise, the |
| | field contains information about the request, the|
| | command, the table name if not an open or close, |
| | the external return code, and the internal return|
| | code. |
+------------------+--------------------------------------------------+
| SIDName | As specified with the CDCM_SIDNAME Multi-User |
| | startup option, identifies the target MUF to the |
| | CDCM subtask. |
+------------------+--------------------------------------------------+
| CPMStatus | CDCM Subtask Status. Valid values are: |
| | OPEN CDCM subtask is open. |
| | CLOSED CDCM subtask is closed. |
| | CLS]OPN CDCM subtask is closed, but you |
| | have requested it to open. |
| | OPN]CLS CDCM subtask is open, but you have|
| | requested it to close. |
| | OPN-ING CDCM subtask is in the process of |
| | opening. |
| | CLS-ING CDCM subtask is in the process of |
| | closing. |
+------------------+--------------------------------------------------+
| PollStatus | CDCM Poll Status. Valid values are: |
| | WAITENBL Waiting on source MUF to be |
| | enabled, where CDCM is not running|
| | its target MUF. |
| | CLOSED CDCM is currently defined as |
| | closed, and is waiting for a |
| | CDCM_OPEN request. |
| | WAITPOLL CDCM is connected to the source |
| | MUF and is waiting for the next |
| | poll interval to check the status |
| | again. |
| | WAIT-RQ- CDCM is connected or connecting to|
| | the source MUF and waiting on a |
| | request. |
| | RUNNING CDCM is actively running or |
| | wait-on a CP to run. |
+------------------+--------------------------------------------------+
| CNTTB | Provides information regarding the performance |
| | option, as specified with the CDCM_CNTTB |
| | Multi-User startup option, that allows the CDCM |
| | subtask to use CNTTB commands to determine the |
| | number of transaction sequence number (TSN) |
| | records and maintenance (MNT) LXX records in the |
| | CDC database. This count of records is checked |
| | at the polling intervals set with the CDCM_POLL |
| | Multi-User startup option. In a MUFplex with two |
| | or more MUFs enabled, a CNTTB command provides |
| | only the number known to the local MUF, not to |
| | the MUFplex as a whole. |
+------------------+--------------------------------------------------+
| CurDate | Current date from the MUF. |
+------------------+--------------------------------------------------+
| CurTime | Current time from the MUF. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCCDCBT

DCCDCBT Command

The DCCDCBT command displays the MUF_CDC_BASE_TABLE Dynamic System


table which reflects the current settings of the CDC_BASE and the
CDC_TABLE Multi-user startup options as changed by console-like
CDC_BASE and CDC_TABLE commands.

Command Syntax

+------------------+--------------------------------------------------+
| DCCDCBT | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| MUFName | Name of the Multi-User Facility (MUF) specified |
| | in the MUF Multi-user startup option or the MUF |
| | jobname. |
+------------------+--------------------------------------------------+
| DBID | The database identifier (database ID). |
+------------------+--------------------------------------------------+
| Table | For CDC_TABLE entries, contains the table name |
| | that has been set to participate or to not |
| | participate. For CDC_BASE entries, contains |
| | blanks. |
+------------------+--------------------------------------------------+
| Propagate | Contains PROPAGATE if this entry is subject to |
| | CDC. Contains blanks if this entry is not |
| | subject to CDC. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCCDCL

DCCDCL Command

The DCCDCL command displays the MUF_CDCL Dynamic System Table which
displays information about the Change Data Capture Listener tasks
defined to the current MUF.

Command Syntax

+------------------+--------------------------------------------------+
| DCCDCL | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| MUFName | Name of the Multi-User Facility (MUF) specified |
| | in the Multi-user startup option or the MUF |
| | jobname. |
+------------------+--------------------------------------------------+
| CDCLName | Identifies the name, as specified in the CDCL |
| | Multi-User startup option, of the source MUF |
| | owning the LXX. |
+------------------+--------------------------------------------------+
| CPLDBID | The database identifier specified with the |
| | CDCL_DBID Multi-User startup option, that is, |
| | the DBID containing the CDC table(s). |
+------------------+--------------------------------------------------+
| Mode | Valid values are: |
| | |
| | LOCAL - refers to LOCAL processing |
| | REMOTE(DS) - The data set name does not match |
| | the local LXX. |
| | REMOTE(WB) - The MUF CDC startup option did not |
| | provide a work buffer. |
| | REMOTE(MP) - The MUF currently has two or more |
| | MUFplex MUFs enabled. |
| | REMOTE(XD) - Remote status has been forced with |
| | a debugging option. |
| | |
| | Note: The debugging option just |
| | mentioned is intended only for use |
| | by those who have received |
| | information about it, that is, |
| | by Technical Support. |
+------------------+--------------------------------------------------+
| Reads | The number of I/O events directed to the LXX |
| | used by the source MUF. |
+------------------+--------------------------------------------------+
| Maint | The number of maintenance log records processed |
| | that were subject to CDC. |
+------------------+--------------------------------------------------+
| Wrap | The number of times the CDCL task has read the |
| | LXX and found it newer than expected. This |
| | indicates that the LXX has completely circled |
| | around (wrapped) while the CDCL was running or |
| | stopped. |
+------------------+--------------------------------------------------+
| Poll | Indicates how long, as specified by the |
| | CDCL_POLL Multi-User startup option, the CDCL |
| | task is to wait when there are no LXX records to |
| | process. Only used when the CDCL task operates |
| | in remote mode. |
+------------------+--------------------------------------------------+
| CntlID | Identifies to the CDC monitor, as specified with |
| | the CDCM_ID Multi-User startup option, which |
| | level of support is being used by the CDCL task. |
| | This information is used in the CNTKR commands |
| | track the correct records. The letter A is the |
| | valid control ID. |
+------------------+--------------------------------------------------+
| Status | Valid values are: |
| | |
| | OPN]CLS - Open but has been requested to close. |
| | CLS]OPN - Closed but has been requested to open. |
| | OPEN - Currently open |
| | CLOSED - Currently closed |
+------------------+--------------------------------------------------+
| GapWait | Indicates that this CDCL task is in a GAP |
| | situation and waiting to be notified that it has |
| | resolved and needs to try again. |
+------------------+--------------------------------------------------+
| DDNAME | Name of the DD statement used to read the LXX |
| | data set of the source MUF. |
+------------------+--------------------------------------------------+
| DatasetName | Name of the data set that is the LXX of the |
| | source MUF. |
+------------------+--------------------------------------------------+
| ErrorText | Either contains blanks if no error has occurred |
| | since this listener was last opened successfully,|
| | or contains information about the last error. |
| | The many values that are possible are described |
| | in the explanatory description of message |
| | DB03153E. |
+------------------+--------------------------------------------------+
| CPDate | Date for the last log record that was subject to |
| | CDC. |
+------------------+--------------------------------------------------+
| CPTime | Time for the last log record that was subject to |
| | CDC. |
+------------------+--------------------------------------------------+
| LXXDate | Date for the last log record processed, CDC or |
| | not. |
+------------------+--------------------------------------------------+
| LXXTime | Time for the last log record processed, CDC or |
| | not. |
+------------------+--------------------------------------------------+
| CurrDate | Current date from the MUF. |
+------------------+--------------------------------------------------+
| CurrTime | Current time from the MUF. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCCOLUMN

DCCOLUMN Command

The DCCOLUMN command displays information about every column in the


Directory. Column information exists only for those fields defined
to Datadictionary that can contain null values or fields that have
the DBEDITS turned on or both.

Command Syntax

+------------------+--------------------------------------------------+
| DCCOLUMN | [ dbid ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DBID | The request database ID. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DBID | The database ID. |
+------------------+--------------------------------------------------+
| Table | This field contains the DATACOM-NAME |
| | attribute-value of the table containing the |
| | column. |
+------------------+--------------------------------------------------+
| Column | The sequence number of this column within the |
| | columns of the row. |
+------------------+--------------------------------------------------+
| Occurrence | This field contains the Datadictionary entity |
| | occurrence name of this column. |
+------------------+--------------------------------------------------+
| Offset | The displacement or offset of the column from |
| | the start of the row. |
+------------------+--------------------------------------------------+
| Length | The length of the column as it is stored in the |
| | row. This includes one byte if the column can |
| | be null plus two bytes if the column is variable |
| | length. |
+------------------+--------------------------------------------------+
| SQL-Type | This field is set to null if this column was not |
| | defined to Datadictionary with the DBEDITS set |
| | to YES or if this column cannot be represented |
| | by a data type recognized by SQL. Valid values |
| | are: |
| | |
| | NUMERIC Zone decimal |
| | DECIMAL Packed decimal |
| | FLOAT Floating point numbers |
| | SQL-DATE SQL date |
| | SQL-TIME SQL time |
| | SQL-STMP SQL timestamp |
| | SMALLINT 2-byte binary signed number |
| | INTEGER 4-byte binary signed number |
| | CHAR Character field |
| | VARCHAR Variable character field |
| | VARG Variable graphics field |
| | GRAPHIC Graphics field |
+------------------+--------------------------------------------------+
| Semantic | This field is set to null if this column was not |
| | defined to Datadictionary with the DBEDITS set |
| | to YES or if this column has no semantic data |
| | type. Valid values are: |
| | |
| | DATE SQL type date |
| | TIME SQL type time |
| | TIMESTMP SQL type timestamp |
| | MIXED Mixed case data |
| | BIT-DATA For-bit-data |
+------------------+--------------------------------------------------+
| Col-Type | Column type is null if the Datadictionary |
| | DBEDITS attribute is set to NO. Valid values |
| | are: |
| | |
| | NUMERIC Numeric |
| | DECIMAL Decimal |
| | LONGFLT Long float |
| | SHORTFLT Short float |
| | EXTNDFLT Extended float |
| | BINARY Binary |
| | VARG Variable graphics |
| | DBCS DBCS |
| | CHAR Character |
| | VARCHAR Variable character |
+------------------+--------------------------------------------------+
| Chg | Indicates whether a change is allowed. |
+------------------+--------------------------------------------------+
| Dflt | This column is null if the Datadictionary |
| | attribute DBEDITS is set to NO. Valid values |
| | are: |
| | |
| | D Standard data type defaults |
| | O A literal is the default value |
| | N No default that indicates that the field |
| | must be provided during every insert |
| | S Security accessor ID is the default value |
| | U The SQL AUTHID is the default value |
+------------------+--------------------------------------------------+
| Null | Specifies whether the column can be set to |
| | nulls. |
+------------------+--------------------------------------------------+
| DBedit | Specifies whether the field was defined with the |
| | Datadictionary DBEDITS attribute on or off. |
+------------------+--------------------------------------------------+
| Add | Specifies whether Datacom/DB is to |
| | force new data to this field when inserting a |
| | row. |
+------------------+--------------------------------------------------+
| Upd | Specifies whether Datacom/DB is to |
| | force new data to this field when updating a |
| | row. |
+------------------+--------------------------------------------------+
| Status | The status of the Datadictionary occurrence name |
| | for this column. |
+------------------+--------------------------------------------------+
| DDVer | The version of the Datadictionary occurrence |
| | name for this column. |
+------------------+--------------------------------------------------+
| Sign | This column is null if not one of the numeric |
| | data types. Otherwise, this column specifies |
| | whether this column was defined as signed |
| | numeric. |
+------------------+--------------------------------------------------+
| ValLn | This field is null if the column did not have |
| | the Datadictionary DBEDITS attribute set to YES |
| | or the default to be other than literal. |
| | Otherwise, this is the length of the literal |
| | that is placed in the column. If this is a |
| | variable character column, then this length |
| | included 2 bytes for the length of the data. |
+------------------+--------------------------------------------------+
| ValChar | This field is null if the column did not have |
| | the Datadictionary DBEDITS attribute set to YES |
| | or the default to be other than literal. |
| | Otherwise, this is the character form of the |
| | data to be placed in the column. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCCONFIG

DCCONFIG Command

The DCCONFIG command displays nearly all Multi-User startup options


and console API commands that are not represented in another Dynamic
System Table.

Command Syntax

+------------------+--------------------------------------------------+
| DCCONFIG | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| MUFName | Name of the Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| ConfigCommand | The configuration command entered by the user, |
| | up to field maximum. |
+------------------+--------------------------------------------------+
| Parameters | The operand or operands entered by the user, up |
| | to field maximum. The operand is exactly as the |
| | user specified it up to the 65 byte limit. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCDATASH

DCDATASH Command

The DCDATASH command displays information about MUF data sharing.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DCDATAsh | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | [ XSGroup name ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | |
| | This value can be also be set by issuing the |
| | SET DCMODE REGION command. |
| | |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Datacom address |
| | spaces on the current system. |
| | |
| | This value can also be set by issuing the |
| | SET DCMODE SYSTEM command. |
| | |
| | The current XSDATA profile setting for the |
| | command is honored. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSYStem | Display data for all Datacom address spaces for |
| XSData | all systems. This forces cross system data |
| | collection to be set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The Datacom job name. |
+------------------+--------------------------------------------------+
| MUFname | The Multi-User-Facility name. |
+------------------+--------------------------------------------------+
| Calls | Total number of calls made to the Coupling |
| | Facility using XES. |
+------------------+--------------------------------------------------+
| Lists | Total calls made to the Coupling Facility |
| | to support list structure processing. |
+------------------+--------------------------------------------------+
| Locks | Total calls made to the Coupling Facility |
| | to support lock structure processing. |
+------------------+--------------------------------------------------+
| SRBCnt | Times an SRB was executed in support of the |
| | Coupling Facility processing. |
+------------------+--------------------------------------------------+
| MsgIn | Times a message was received from another |
| | Multi-User Facility in support of Data Sharing |
| | processing. |
+------------------+--------------------------------------------------+
| MsgOut | Times a message was send to another Multi_User |
| | Facility in support of Data Sharing processing. |
+------------------+--------------------------------------------------+
| Sets | Times a list lock was requested. |
+------------------+--------------------------------------------------+
| Rels | Times a list lock was released. |
+------------------+--------------------------------------------------+
| Reads | Times a list record was requested for read. |
+------------------+--------------------------------------------------+
| Writes | Times a list record was requested to be written |
| | or deleted. |
+------------------+--------------------------------------------------+
| LObtains | Times a lock structure lock was requested |
| | (excluding buffers). |
+------------------+--------------------------------------------------+
| LAlters | Times a lock structure lock was escalated from |
| | share to exclusive (excluding buffers). |
+------------------+--------------------------------------------------+
| LRels | Times a lock structure lock was released |
| | (excluding buffers). |
+------------------+--------------------------------------------------+
| LCont | Times contentions occurred for a lock structure |
| | lock (excluding buffers). |
+------------------+--------------------------------------------------+
| BObtains | Times a lock structure buffer lock was |
| | requested. |
+------------------+--------------------------------------------------+
| BAlters | Times a lock structure buffer lock was escalated |
| | from share to exclusive. |
+------------------+--------------------------------------------------+
| BRels | Times a lock structure buffer lock was |
| | released. |
+------------------+--------------------------------------------------+
| BCont | Times contentions occurred for a lock structure |
| | buffer lock. |
+------------------+--------------------------------------------------+
| LEnt | High water mark for number of entries in the |
| | list structure. |
+------------------+--------------------------------------------------+
| LElem | High water mark for number of 256-byte entries |
| | in the list structure. |
+------------------+--------------------------------------------------+
| Buff | High water mark for number of 256-byte entries |
| | used for buffers. |
+------------------+--------------------------------------------------+
| MaxEnt | The approximate maximum number of entries allowed|
| | in the list structure. |
+------------------+--------------------------------------------------+
| MaxElem | The approximate maximum number of 256-byte |
| | entries allowed in the list structure. |
+------------------+--------------------------------------------------+
| LRefused | Number of times that contention processing |
| | rejected a lock request. |
+------------------+--------------------------------------------------+
| EntRatio | Denominator of fraction representing ratio of |
| | elements to entries. |
+------------------+--------------------------------------------------+
| EleRatio | Numerator of the fraction representing ratio of |
| | elements to entries. The mean list entry size |
| | should be approximated by: |
| | |
| | EleRatio * 256 / EntRatio |
+------------------+--------------------------------------------------+
| MaxStrSz | Maximum storage of list structure. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCDBASES

DCDBASES Command

The DCDBASES command displays one entry for each database in the
Directory.

Command Syntax

+------------------+--------------------------------------------------+
| DCDBASEs | [ dbid ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DBID | The request database ID. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| Occurrence | The entity occurrence name for the database |
| | from datadictionary. |
+------------------+--------------------------------------------------+
| Part | Specifies whether the database is partitioned. |
+------------------+--------------------------------------------------+
| Read | Reflects whether any of the tables in the |
| | database are currently open with UPDATE=NO. |
+------------------+--------------------------------------------------+
| Rep | Specifies whether the database can be |
| | replicated. |
+------------------+--------------------------------------------------+
| SQL | Specifies whether SQL Security has been selected |
| | for the tables in this database. |
+------------------+--------------------------------------------------+
| Format | Contains the current database format for this |
| | DBID. Valid values are: |
| | |
| | 1 Used by a prior Datacom release. |
| | 2 All r12.0 features are enabled. |
| | 3 Reflects a base open by r15.0. |
+------------------+--------------------------------------------------+
| Upd | Specifies whether the database is currently open |
| | for update. |
+------------------+--------------------------------------------------+
| JobName | If this DBID is open for update, this is the job |
| | name from the last open for update. |
+------------------+--------------------------------------------------+
| OpenDate | The date and time of the User Requirements Table |
| OpenTime | open for a table in this database. If the |
| | database is currently open for read-only, then |
| | the date and time can reflect a previous open |
| | for update. If the table was opened by multiple |
| | tasks concurrently, then the date and time can |
| | reflect any of the tasks. This field can be |
| | null if a new database is cataloged and no User |
| | Requirements Tables have been opened. |
+------------------+--------------------------------------------------+
| UpdtDate | The date and time of the last User Requirements |
| UpdtTime | Table open for update. If the table was opened |
| | by multiple tasks concurrently, then the date |
| | and time can reflect any of the tasks. This |
| | field can be null if a new database is cataloged |
| | and no User Requirements Tables have been |
| | opened. |
+------------------+--------------------------------------------------+
| RstrDate | This field is null if a new database is |
| RstrTime | cataloged and the RESTART processing at |
| | Multi-User-Facility enable has not occurred for |
| | this database nor has the RESET function of |
| | DBUTLTY been done for this base (when the |
| | database was open). Otherwise, it is the date |
| | and time of the last RESTART processing or RESET |
| | function for this base. |
+------------------+--------------------------------------------------+
| MntDate | The date and time that the database definition |
| MntTime | was last cataloged or maintained through |
| | CXXMAINT options except the ALTER option. |
+------------------+--------------------------------------------------+
| VerDD | Specifies the version of the occurrence of the |
| | database datadictionary definition. |
+------------------+--------------------------------------------------+
| Status | Specifies whether the database is currently |
| | open for update. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the DCAREAS command for the selected |
| | database. |
+------------------+--------------------------------------------------+
| Areas | Invokes the DCAREAS command for the selected |
| | database. |
+------------------+--------------------------------------------------+
| DSets | Invokes the DCDSETS command for the selected |
| | database. |
+------------------+--------------------------------------------------+
| IO | Invokes the DCAREAIO command for the selected |
| | database. |
+------------------+--------------------------------------------------+
| Tables | Invokes the DCTABLES command for the selected |
| | database. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCDIR

DCDIR Command

The DCDIR command displays information about the directory in


general.

Command Syntax

+------------------+--------------------------------------------------+
| DCDIR | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Directory name | The MUF directory name. |
+------------------+--------------------------------------------------+
| TVer | Contains the table version (generation level) |
| | of the table. |
| | |
| | This field is valid starting with Datacom r15.0. |
+------------------+--------------------------------------------------+

Data Fields

Type
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Type | The type of Datacom/DB directory |
| | being processed. Valid values are: |
| | |
| | Datacom/DB Full |
| | Datacom/AD Restricted |
+------------------+--------------------------------------------------+

Database Identifier
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Datadictionary | The database identifier of the primary |
| | Datadictionary containing the DATA-DICT database |
| | and the High-Speed Directory. |
+------------------+--------------------------------------------------+
| Data Definition | The database identifier of the Data Definition |
| Directory | Directory (DDD) used in SQL processing and by |
| | products using SQL. |
+------------------+--------------------------------------------------+

Security
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Specifies whether the jobname is to be used if |
| | running with Datacom/DB Security |
| | installed. This only applies to Release 9.0. |
| | |
+------------------+--------------------------------------------------+
| Single user | Specifies whether you can run a single user |
| | environment with Datacom/DB |
| | Security installed. |
+------------------+--------------------------------------------------+

Statistics
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Run Unit | The last run unit number assigned to an existing |
| | Datacom/DB job. |
+------------------+--------------------------------------------------+

Options
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| SQL Support | Specifies if a Multi-User-Facility with |
| | Multi-User startup option SQLOPTION has |
| | executed. |
+------------------+--------------------------------------------------+

Character Sets
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Defaults | Specifies a default that character fields are |
| | assumed to be Single Byte Character Set or |
| | Mixed characters allowing shift out/in |
| | characters. |
+------------------+--------------------------------------------------+
| Shift Codes | Specifies the type of shift codes embedded in |
| | the mixed character fields. |
| | |
| | MVS |
| | Fujitsu MSP |
+------------------+--------------------------------------------------+
| Language | Specifies whether Katakana language is |
| | supported. |
+------------------+--------------------------------------------------+

CXX Settings
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Dataset Extent | Specifies the current setting for Dataset |
| Validation | Extent Validation, YES or No. This can be |
| | changed by running CXXMAINT. |
+------------------+--------------------------------------------------+
| Locking | Specifies the level of CXX locking in effect, |
| | either LOCAL or SYSPLEX. This can be changed by |
| | running CXXMAINT. |
+------------------+--------------------------------------------------+
| Data Fast Search | Specifies the current setting for Data Fast |
| | Search, YES or NO. This can be changed by |
| | running CXXMAINT. |
+------------------+--------------------------------------------------+
| Data High Used | Specifies the current setting for Data High Used |
| Mark | Mark, YES or NO. This can be changed by running |
| | CXXMAINT. |
+------------------+--------------------------------------------------+
| Compatibility | Specifies the CXX Compatibility level. |
| Level | |
+------------------+--------------------------------------------------+
| Simplify Mode | Indicates whether or not the CXX has been |
| | initialized with Simplify Mode, YES or NO. |
+------------------+--------------------------------------------------+
| Version | The directory's version, for example '14.0' |
| | (that is 14.0 plus two blanks to make six |
| | characters). Note that Version 15.0 runs with a |
| | CXX_VERSION setting at 14.0. |
| | |
| | This field is valid starting with Datacom r15.0. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes
This command performs an automatic address space switch to the
jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCDSETS

DCDSETS Command

The DCDSETS command displays one entry for the Directory (CXX), one
for every (IXX), and one for every data area.

Command Syntax

+------------------+--------------------------------------------------+
| DCDSETs | [ dbid ] |
| | [ VOLser | NOVolser ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+
| VOLSER | Display the VOLSER associated with the |
| | data set name. |
| | In some cases, locating the associated VOLSER |
| | for a large number of data sets can increase |
| | the response time of the command. |
+------------------+--------------------------------------------------+
| NOVOLSER | Do not display the VOLSER associated with the |
| | data set name. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DBID | The request database ID. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| Area | The name of the area. |
+------------------+--------------------------------------------------+
| Pct% | Specifies the percent of the data set that is |
| | full. |
| | |
| | pct = InUse / Blocks |
+------------------+--------------------------------------------------+
| Pct-Full | The graphic display of the percent of the data |
| | set that is full. |
| | |
| | pct = InUse / Blocks |
+------------------+--------------------------------------------------+
| Dataset-Name | This field can be blank if the data set is not |
| | known. This can occur for new databases before |
| | the areas are initialized, or when the database |
| | loaded from a Directory (CXX) backup and the |
| | base is new, or for areas that have not been |
| | initialized for several releases of |
| | Datacom/DB. |
+------------------+--------------------------------------------------+
| PartBlks | This field is zero in the entries for the |
| | Directory (CXX) and Index Area (IXX) if the |
| | area is not initialized, or if space option 0 |
| | (no reclamation) is selected. Otherwise, this |
| | field contains the number of blocks that |
| | probably have space to add one or more records. |
| | In compressed tables and areas with multiple |
| | tables of different lengths, for a specific |
| | add, space may not exist. In support of |
| | transaction backout, some space is not actually |
| | available until a transaction is committed. |
+------------------+--------------------------------------------------+
| InUse | The field can be zero if the area is not |
| | initialized. This field contains a count of the |
| | number of blocks that contain active |
| | information. |
+------------------+--------------------------------------------------+
| MaxBlks | This field can be zero if the area has not been |
| | initialized. Otherwise, this is a high water |
| | mark as to how full the area has been. |
+------------------+--------------------------------------------------+
| Max% | The maximum percentage high water mark of how |
| | full the area has been. |
+------------------+--------------------------------------------------+
| Blocks | This field can be zero if the area has not been |
| | initialized. Otherwise, it contains the number |
| | of blocks in the area. |
+------------------+--------------------------------------------------+
| Blksize | The length of each block in this area. |
+------------------+--------------------------------------------------+
| Tracks | This field can be zero if the area has not been |
| | initialized. Otherwise, it contains the number |
| | of tracks allocated and accepted for use. |
+------------------+--------------------------------------------------+
| Volser | This field contains the volser where the data |
| | set resides. |
+------------------+--------------------------------------------------+
| Device | This field contains the device type for the data |
| | set. |
+------------------+--------------------------------------------------+
| SecCyls | The secondary allocation is only reported in |
| | cylinders. The number reported is a maximum size |
| | of 64k-1 (65535). This number reflects size |
| | 65535 and all larger sizes. |
| | |
| | The size reported was the last time the area was |
| | opened when the base was opened for update. |
| | During a dynamic extend, the size is subject to |
| | the data set having a specific JCL DD statement |
| | with a different secondary. The size is subject |
| | to a CXX BACKUP function and restored with the |
| | base restore. The information is not disabled if |
| | input into a back level of Datacom and then |
| | subject to a backup there and restored into a |
| | 15.0 CXX. If the information is not currently |
| | correct, then it is corrected the next open for |
| | update of the data set. |
| | |
| | If the allocation was done in average block then |
| | the secondary size from the JCL is converted |
| | into tracks (rounding down) and then into |
| | cylinders (rounding down). If the allocation was |
| | done in tracks then the secondary size from the |
| | JCL is converted into cylinders (rounding down). |
| | Therefore, a value reported as 0 might mean no |
| | secondary or a secondary of a size less than a |
| | full cylinder. |
| | |
| | This field may have no value if: |
| | |
| | - The data set has not been opened in the past |
| | with 15.0 code installed. |
| | |
| | - It was opened without the database being |
| | opened for update. |
| | |
| | - The area was opened in MUF and defined as |
| | Virtual. |
| | |
| | - The area was opened for update but was defined |
| | in the JCL as a 'TEMP' data set (DSN starting |
| | with &&). |
| | |
| | This field is valid starting with Datacom r15.0. |
+------------------+--------------------------------------------------+
| TVer | Contains the table version (generation level) |
| | of the table. |
| | |
| | This field is valid starting with Datacom r15.0. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| DSinfo | Invokes the DSINFO command for the data set |
| Info | name. |
+------------------+--------------------------------------------------+
| LC | Invokes the LISTCAT command for the current |
| | data set. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCDUMPL

DCDUMPL Command

The DCDUMPL command displays Multi-User-Facility dump information for


last 10 Master List dumps requested by Datacom address spaces.

Command Syntax

+------------------+--------------------------------------------------+
| DCDUMPL | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| JobName | Job name that produced the dump. |
+------------------+--------------------------------------------------+
| MUFname | The Multi-User-Facility name. |
+------------------+--------------------------------------------------+
| DumpNum | Dump number. |
+------------------+--------------------------------------------------+
| Command | Command that was active when the dump occurred. |
+------------------+--------------------------------------------------+
| ExtRC | The external return code for the dump |
+------------------+--------------------------------------------------+
| IntRC | The internal return code for the dump. |
+------------------+--------------------------------------------------+
| Rsn | Reason code for the dump. |
+------------------+--------------------------------------------------+
| R15Err | The error code value from register 15. |
+------------------+--------------------------------------------------+
| Program | Program that was active when the dump occurred. |
+------------------+--------------------------------------------------+
| Offs | Offset into the program where the dump occurred. |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| Tbl | The table name. |
+------------------+--------------------------------------------------+
| TaskNum | The number of the task area being used for the |
| | request, also known as the RWTSA number. |
+------------------+--------------------------------------------------+
| RunUnit | The internal number assigned by |
| | Datacom/DB to each Datacom job. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

Some of the data fields will be blank or contain 0 if no value was


supplied.

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCDUMPS

DCDUMPS Command

The DCDUMPS command displays Multi-User-Facility dump information for


Datacom address spaces.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DCDUMPs | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | [ XSGroup name ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | |
| | This value can be also be set by issuing the |
| | SET DCMODE REGION command. |
| | |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Datacom address |
| | spaces on the current system. |
| | |
| | This value can also be set by issuing the |
| | SET DCMODE SYSTEM command. |
| | |
| | The current XSDATA profile setting for the |
| | command is honored. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSYStem | Display data for all Datacom address spaces for |
| XSData | all systems. This forces cross system data |
| | collection to be set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Datacom address space job name. |
+------------------+--------------------------------------------------+
| MUFname | The Multi-User-Facility name. |
+------------------+--------------------------------------------------+
| DumpNum | Dump number. |
+------------------+--------------------------------------------------+
| Reqname | Name of the address space that created the dump. |
+------------------+--------------------------------------------------+
| Command | Command that was active when the dump occurred. |
+------------------+--------------------------------------------------+
| ExtRC | The external return code for the dump |
+------------------+--------------------------------------------------+
| IntRC | The internal return code for the dump. |
+------------------+--------------------------------------------------+
| Rsn | Reason code for the dump. |
+------------------+--------------------------------------------------+
| R15Err | The error code value from register 15. |
+------------------+--------------------------------------------------+
| Program | Program that was active when the dump occurred. |
+------------------+--------------------------------------------------+
| Offs | Offset into the program where the dump occurred. |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| Tbl | The table name. |
+------------------+--------------------------------------------------+
| TaskNum | The number of the task area being used for the |
| | request, also known as the RWTSA number. |
+------------------+--------------------------------------------------+
| RunUnit | The internal number assigned by |
| | Datacom/DB to each Datacom job. |
+------------------+--------------------------------------------------+
XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

Some of the data fields will be blank or contain 0 if no value was


supplied.

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCELEMEN

DCELEMEN Command

The DCELEMEN command displays one entry for every element in the
Directory. Information describing each element is displayed.

Command Syntax

+------------------+--------------------------------------------------+
| DCELEMen | [ dbid ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DBID | The request database ID. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| Table | This field contains the DATACOM-NAME of the |
| | table containing the element. |
+------------------+--------------------------------------------------+
| Element | This field contains the short name (DATACOM-NAME |
| | attribute-value) assigned to the element. |
+------------------+--------------------------------------------------+
| Occurrence | The Datadictionary entity-occurrence name for |
| | this element. |
+------------------+--------------------------------------------------+
| Offset | This field contains the offset of displacement |
| | from the start of the row to the start of this |
| | element. |
+------------------+--------------------------------------------------+
| Length | This field contains the length of the element. |
+------------------+--------------------------------------------------+
| SecCode | The element security code in numeric form. |
+------------------+--------------------------------------------------+
| Status | The status of the occurrence. |
+------------------+--------------------------------------------------+
| DDVer | Specifies the version of the Datadictionary |
| | occurrence of this area. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCINDEX

DCINDEX Command

The DCINDEX command displays an entry for each Index Area in the
Directory (CXX).

Command Syntax

+------------------+--------------------------------------------------+
| DCINdex | [ dbid ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DBID | The request database ID. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DirName | The directory (CXX) name being used by this MUF. |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| Area | The Datacom name of the index area. |
+------------------+--------------------------------------------------+
| Link | Specifies whether the CXX link option is in |
| | place for this Index Area. |
+------------------+--------------------------------------------------+
| Extend | Specifies whether dynamic extends are allowed |
| | for this Index Area. |
+------------------+--------------------------------------------------+
| ExtType | Contains the type of value specified for dynamic |
| | extend. Valid values are: |
| | Blank None specified |
| | CYL Cylinders |
| | TRK Tracks |
+------------------+--------------------------------------------------+
| ExtVal | Contains the number of tracks or cylinders to |
| | request if dynamic extend is selected. Contains |
| | a zero if dynamic extend is not selected. |
| | |
| | When dynamic extend is selected, tracks or |
| | cylinders specified here (if not zero) are used |
| | during each dynamic extend. If zero here, the |
| | VTOC JCL secondary allocation is used. This |
| | field is not used during an EXTEND function in |
| | DBUTLTY. |
+------------------+--------------------------------------------------+
| Levels | The count of the number of high-level index |
| | levels. |
+------------------+--------------------------------------------------+
| OldEnt | Indicates whether this Index Area was initiated |
| | with OLDEP (old entry point) support. The index |
| | works more efficiently with OLDEP not set. |
+------------------+--------------------------------------------------+
| Format | The format of the index. This field will only be |
| | filled in if the TVer value is greater than 0. |
| | |
| | This field is valid starting at Datacom r15.1 |
| | with SO15152 applied. |
+------------------+--------------------------------------------------+
| TVer | Contains the table version (generation level) |
| | of the table. |
| | |
| | This field is valid starting at Datacom r15.1. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCKEYFLD

DCKEYFLD Command

The DCKEYFLD command displays every key field in the Directory.


Each entry includes information that exists for that specific key
field.

Command Syntax

+------------------+--------------------------------------------------+
| DCKEYFLD | [ dbid ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DBID | The request database ID. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| Table | This field contains the short name (DATACOM-NAME |
| | attribute-value) of the table containing the key |
| | field. |
+------------------+--------------------------------------------------+
| Key | This field contains the short name (DATACOM-NAME |
| | attribute-value) of the key containing this |
| | field. |
+------------------+--------------------------------------------------+
| Occurrence | This field contains the Datadictionary |
| | entity-occurrence name for this field. |
+------------------+--------------------------------------------------+
| Seq | The sequence number (1-n) of this field within |
| | this key definition. |
+------------------+--------------------------------------------------+
| Offset | The offset of displacement from the start of the |
| | row to the start of this field. |
+------------------+--------------------------------------------------+
| Length | This field contains the length of this key |
| | field. |
+------------------+--------------------------------------------------+
| Unique | The number of rows indexed to be unique assuming |
| | all fields of this key from the left through |
| | this key field. This field can be zero for a |
| | new table or key. The value is set during the |
| | LOAD, RETIX, (not if KEYNAME=*DATA), or |
| | REPORT....TYPE=G,UPDATE utilities. |
+------------------+--------------------------------------------------+
| Dec | Specifies whether this field is Packed Decimal |
| | type sensitive. |
+------------------+--------------------------------------------------+
| Num | Specifies whether this field is numeric (zoned |
| | decimal) data-type sensitive. |
+------------------+--------------------------------------------------+
| Sign | Specifies whether this field is a signed integer |
| | (binary number) data-type sensitive. |
+------------------+--------------------------------------------------+
| Float | Specifies whether this field is FLOAT data-type |
| | sensitive. |
+------------------+--------------------------------------------------+
| Order | The order of the field with either an A for |
| | ascending or a D for descending. |
+------------------+--------------------------------------------------+
| Null | Specifies whether this field can be null. |
+------------------+--------------------------------------------------+
| Status | This field contains the Datadictionary status of |
| | this field. |
+------------------+--------------------------------------------------+
| DDVer | This field contains the version of the |
| | Datadictionary entity-occurrence for this key |
| | field. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCKEYS

DCKEYS Command

The DCKEYS command displays one entry for every key in the
Directory. Information describing each key is displayed.

Command Syntax

+------------------+--------------------------------------------------+
| DCKEYs | [ dbid ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DBID | The request database ID. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| Table | This field contains the DATACOM-NAME of the |
| | table containing the key field. |
+------------------+--------------------------------------------------+
| Key | This field contains the name of the key. |
+------------------+--------------------------------------------------+
| Occurrence | The Datadictionary entity-occurrence name for |
| | this key definition. |
+------------------+--------------------------------------------------+
| Length | This field contains the length of the key to be |
| | indexed. |
+------------------+--------------------------------------------------+
| KeyStatus | This column contains status information for the |
| | key. More than one status can be listed for a |
| | given key as appropriate. Possible values are: |
| | |
| | AD Signifies the key was added |
| | through an APPLYCXX but the |
| | process of populating the index |
| | which makes the key usable is not |
| | complete. |
| | DL Indicates that the key was |
| | deleted through an APPLYCXX but |
| | the process of removing the key |
| | from the index is not complete. |
| | LD Key is loaded and ready for use. |
| | NL Key is neither loaded nor |
| | available to the user. |
+------------------+--------------------------------------------------+
| Records | This field contains the number of records |
| | indexed by the key. If a system failure occurs |
| | during maintenance, then the number can be |
| | inaccurate. |
+------------------+--------------------------------------------------+
| Searched | This field contains the number of rows indexed |
| | when the unique counts in the keys field were |
| | generated. |
+------------------+--------------------------------------------------+
| KeyID | This field contains the key ID of this key. |
+------------------+--------------------------------------------------+
| Parent | This field contains the database identifier of |
| | the database of the table that is referenced if |
| | this is a FOREIGN key. This field is null if |
| | the key is not subject to an SQL referential |
| | integrity constraint. |
+------------------+--------------------------------------------------+
| PTable | This field contains the short name (DATACOM-NAME |
| | attribute-value) of the table that is referenced |
| | if this is a FOREIGN key. This field is null if |
| | the key is not subject to an SQL referential |
| | integrity constraint. |
+------------------+--------------------------------------------------+
| Date | This field contains the date at which the index |
| | was scanned and the unique count fields were |
| | last computed. This field can be null. |
+------------------+--------------------------------------------------+
| Time | This field contains the time at which the index |
| | was scanned and the unique count fields were |
| | last computed. This field can be null. |
+------------------+--------------------------------------------------+
| Version | Specifies the version of the Datadictionary |
| | entity-occurrence for the key. |
+------------------+--------------------------------------------------+
| Status | The status of the occurrence. |
+------------------+--------------------------------------------------+
| CBSI | Indicates whether CBS is allowed to use this |
| | key. Field is provided for prior release |
| | compatibility. See the KeyUse field. |
+------------------+--------------------------------------------------+
| KeySQLname | Key SQL name. |
+------------------+--------------------------------------------------+
| Direct | Direct value. |
+------------------+--------------------------------------------------+
| DupMast | Duplicate master indicator. |
+------------------+--------------------------------------------------+
| Master | Master value. |
+------------------+--------------------------------------------------+
| Native | Native value. |
+------------------+--------------------------------------------------+
| Nil | Nil value. |
+------------------+--------------------------------------------------+
| Unique | Specifies whether this key is subject to unique |
| | key constraint. |
+------------------+--------------------------------------------------+
| IndexName | Specifies the index name. It is either IXX (the |
| | default) or an index area name when using index |
| | partitioning. |
+------------------+--------------------------------------------------+
| UsesRAAT | A count of initial locate/read record-at-a-time |
| | commands against this key definition. The count |
| | is incremented by one for every LOC/RED/RDU/CNT |
| | command with KY/KG/KR/KL/KX/KI or GSETL command. |
| | This counter will stop being incremented at one |
| | less than 2 gigabytes until reset to zero during |
| | the next LOAD or RETIX. |
+------------------+--------------------------------------------------+
| UsesCBS | Provides a general key usage count, the times a |
| | SELFR command selected this key for a traversal |
| | set. This does not include population counting |
| | or key usage to determine if the key will |
| | actually be used in the completion of the |
| | request. This count does not include use of the |
| | command by SQL. This counter will stop being |
| | incremented at one less than 2 gigabytes until |
| | reset to zero during the next LOAD or RETIX. |
+------------------+--------------------------------------------------+
| UsesSQL | Provides a general key usage count, the times a |
| | SELFR command selected this key for a traversal |
| | set. This does not include population counting |
| | or key usage to determine if the key will |
| | actually be used in the completion of the |
| | request. This count only includes use of the |
| | command by SQL. This counter will stop being |
| | incremented at one less than 2 gigabytes until |
| | reset to zero during the next LOAD or RETIX. |
+------------------+--------------------------------------------------+
| KeyUse | Contains the value specified for the KEY_USAGE |
| | attribute. Possible values are: |
| | |
| | ANY |
| | RAAT |
| | CBS/SQL |
| | NONE |
| | |
| | This field is valid starting with Datacom r15.0. |
+------------------+--------------------------------------------------+
| TVer | Contains the table version (generation level) |
| | of the table. |
| | |
| | This field is valid starting with Datacom r15.0. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Select | Displays detailed information about the selected |
| | key. |
+------------------+--------------------------------------------------+
| Fields | Invokes the DCKEYFLD command for the current |
| | DBID, TABLE, and KEY. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCLIST

DCLIST Command

The DCLIST command displays information about Datacom address spaces


that are currently being monitored.

A list of active Datacom address spaces will be obtained dynamically.


You may choose to add entries to the DATACOM parmlib member so that
the DCLIST command can indicate the status of all of your Datacoms
even if they have never been active.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DCLIST | [ XSYstem | NOXSYstem ] |
| | [ XSData | NOXSData ] |
| | |
| | [ GROup name ] |
| | [ XSGroup name ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| XSYStem | This forces cross-system data collection to be |
| XSData | set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross-system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+
Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Name | The name of the job. |
+------------------+--------------------------------------------------+
| DCType | Type of Datacom. Valid values are: |
| | |
| | AD - Datacom/AD |
| | DB - Datacom/DB |
| | TR - CCS Datacom/TR |
+------------------+--------------------------------------------------+
| Dispatch | The dispatchability of the address space. |
| | Possible values are: |
| | |
| | RUNNING - The address space has one or more |
| | units of work (tasks or SRBs) |
| | running on a processor. |
| | |
| | READYnnn - The address space has one or more |
| | units of work (tasks or SRBs) that |
| | are dispatchable but are waiting |
| | to run on a processor. The "nnn" |
| | portion is the dispatch priority |
| | order up to a maximum of 255. |
| | |
| | blank - The address space is not |
| | dispatchable. |
+------------------+--------------------------------------------------+
| JobStat | The status of the job. Valid values are: |
| | |
| | NS Nonswappable |
| | LSW Logically swapped |
| | GO OUT Currently being swapped out |
| | GO IN Currently being swapped in |
| | IN Swapped in |
| | OUT TO Swapped out--terminal output wait |
| | OUT TI Swapped out--terminal input wait |
| | OUT LW Swapped out--long wait |
| | OUT XS Swapped out--auxiliary storage |
| | shortage |
| | OUT RS Swapped out--real storage shortage |
| | OUT DW Swapped out--detected wait |
| | OUT RQ Swapped out--requested swap |
| | OUT NQ Swapped out--enqueue exchange swap |
| | OUT EX Swapped out--exchange on recommended |
| | value |
| | OUT US Swapped out--unilateral swap |
| | OUT TS Swapped out--transition swap |
| | OUT IC Swapped out--improve central storage |
| | OUT IP Swapped out--improve system paging |
| | OUT MR Swapped out--make room |
| | OUT AW Swapped out--APPC wait |
| | OUT OI Swapped out--input wait |
| | OUT OO Swapped out--output wait |
| | OUT LS Swapped out--logical swap |
| | OUT LF Swapped out--logical swap fail |
| | OUT SR Swapped out--real swap |
| | blank No address space found with the |
| | specified jobname |
+------------------+--------------------------------------------------+
| Job-CPU | The accumulated CPU time (in CPU seconds) used |
| | by the job. |
+------------------+--------------------------------------------------+
| RealStg | The amount of real storage the job is using in |
| | the private region. |
+------------------+--------------------------------------------------+
| IOReqs | The number of I/O operations performed by the |
| | job. |
+------------------+--------------------------------------------------+
| Clocktime | The amount of wall clock time the job has been |
| | executing. |
+------------------+--------------------------------------------------+
| Jobnr | The job number. |
+------------------+--------------------------------------------------+
| Stepname | The current stepname. Stepnames are displayed |
| | only for jobs that have a stepname coded in the |
| | JCL. |
+------------------+--------------------------------------------------+
| Procname | The current procedure stepname. Procedure |
| | stepnames are displayed only for jobs that use a |
| | PROC statement in the JCL. |
+------------------+--------------------------------------------------+
| Type | The type of job. Valid values are: |
| | |
| | JOB A batch job |
| | STC A started task |
+------------------+--------------------------------------------------+
| JobClass | The job input class. |
+------------------+--------------------------------------------------+
| ASID | The hexadecimal address space ID. |
+------------------+--------------------------------------------------+
| ASCB | The ASCB address for the job. |
+------------------+--------------------------------------------------+
| Release | The Datacom release. |
+------------------+--------------------------------------------------+
| DatasetName | The data set of the loadlib to be used to load |
| | the required Datacom modules. If the value is |
| | blank, then loads are requested from STEPLIB, |
| | LINK LIST, and so on. If the value is "*", then |
| | the data set name is dynamically determined |
| | based on the release. |
+------------------+--------------------------------------------------+
| Volser | The VOLSER specified in the DATACOM parmlib |
| | member to be used with the data set value. If |
| | the value is "*", then none is used. |
+------------------+--------------------------------------------------+
| EXCPO | The EXCPs outstanding. If this value reaches |
| | zero, then an SC22 abend occurs. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.
Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Select | Invokes the DATACOM command for the jobname. |
| | This action selects the address space to be used |
| | in future displays. The currently selected |
| | address space is displayed in the information |
| | section. |
| | |
| | For example: Jobname DATACOM ASID 0039 |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Activity | Invokes the ACTIVITY command selecting the |
| | jobname. |
+------------------+--------------------------------------------------+
| DASHDIR | Invokes the DCDIR dashboard for the selected |
| | Datacom to show directory information. |
+------------------+--------------------------------------------------+
| DASHDBG | Invokes the DCDEBUG dashboard for the selected |
| | Datacom to show debugging information. |
+------------------+--------------------------------------------------+
| DASHMON | Invokes the DCMON dashboard for the selected |
| DASH | Datacom to show monitoring information. |
+------------------+--------------------------------------------------+
| LISTFile | Invokes the LISTFILE command for the selected |
| LF | jobname. |
+------------------+--------------------------------------------------+
| JJobque | Invokes the JJOBQUE command for the selected |
| LJ | jobname. |
+------------------+--------------------------------------------------+
| SUBtasks | Invokes the TASKS command to list the subtasks. |
+------------------+--------------------------------------------------+
| Tasks | Invokes the DCTASKS command for the selected |
| | Datacom. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
DCLOCKS

DCLOCKS Command

The DCLOCKS command displays information about the current


contents of the value lock table. One row exists for each value
lock in existence. Value locks are utilized by a Multi-User
Facility to protect a process that needs protection.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DCLOCKs | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | [ XSGroup name ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | |
| | This value can be also be set by issuing the |
| | SET DCMODE REGION command. |
| | |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Datacom address |
| | spaces on the current system. |
| | |
| | This value can also be set by issuing the |
| | SET DCMODE SYSTEM command. |
| | |
| | The current XSDATA profile setting for the |
| | command is honored. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSYStem | Display data for all Datacom address spaces for |
| XSData | all systems. This forces cross system data |
| | collection to be set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Datacom address space job name. |
+------------------+--------------------------------------------------+
| MUFName | The Multi-User-Facility name. |
+------------------+--------------------------------------------------+
| Reqname | Contains the job name owning this lock. If the |
| | value begins with three asterisks (***), it |
| | means that the lock is owned by a system task. |
+------------------+--------------------------------------------------+
| TaskNum | Contains the task number owning this value lock. |
| | Some internal locks are acquired and assigned to |
| | system tasks or are assigned to the primary task |
| | of the job. |
+------------------+--------------------------------------------------+
| Duration | Contains the time the lock has been held in the |
| | format mmm:ss where mmm is minutes and ss is |
| | seconds. If the lock is a share, then the time |
| | is for the first task getting the share. The |
| | formatting is the same as the ACTIVE_TASKS and |
| | STATUS in that a value of less than one second |
| | is reflected as all blanks and a value of |
| | greater than 999:59 is reflected as +++:++. |
+------------------+--------------------------------------------------+
| Type | Contains the type of lock. Valid values are |
| | EXCLUSIVE or SHARE. |
+------------------+--------------------------------------------------+
| LockLength | Contains the length of the lock in its internal |
| | form. A length of over 50 indicates the value |
| | has been truncated. This condition allows |
| | duplicates to not be provided. |
+------------------+--------------------------------------------------+
| Value | Contains the value lock with limited formatting. |
| | Known values locked, that have binary or |
| | hexadecimal fields, are formatted in a useful |
| | way. Unknown values are formatted in another way |
| | with character and hexadecimal values provided. |
| | This formatted format is how the table must be |
| | queried, if all values are being acquired. |
| | Because of the truncation of the value, actual |
| | unique entries that are duplicated within the |
| | first externalized 64 bytes have only the first |
| | occurrence externalized (this condition is very |
| | unlikely). The formatting sets the first 6 bytes |
| | to be the first 6 bytes of the value lock, |
| | followed by a blank, and then match that done |
| | for the ACTIVE_TASKS conditions of waiting for a |
| | value lock. It is also the same format as that
| | used for the console STATUS command and the |
| | DBUTLTY FUNCTION=COMM,OPTION=STATUS. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCLOG

DCLOG Command

The DCLOG command displays information about the logging environment


and status.

Command Syntax

+------------------+--------------------------------------------------+
| DCLOG | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| TVer | Contains the table version (generation level) |
| | of the table. |
| | |
| | This field is valid starting with Datacom r15.0. |
+------------------+--------------------------------------------------+
Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DBID | The database ID. This field contains 0. |
+------------------+--------------------------------------------------+
| Area | The area name. This field contains LXX. |
+------------------+--------------------------------------------------+
| BlockLen | This field contains the physical block size. It |
| | is also the logical block size if the BlksLog |
| | field contains a 1. |
+------------------+--------------------------------------------------+
| Blocks | The number of Log blocks (logical) that are |
| | available for logging records. The first |
| | logical block is reserved and used as a control |
| | block so this block is excluded from the count. |
| | Also, the last physical block is reserved and is |
| | used to contain information the RESTART process |
| | may need and also 2-phase commit information |
| | when running with Datacom STAR Option. |
+------------------+--------------------------------------------------+
| InUse | The number of blocks in the Log Areas that |
| | contain active Log records. If spilling is |
| | active, then this includes all blocks in the |
| | cycle being spilled in addition to the blocks |
| | built after the blocks being spilled. At |
| | completion of a spill, the spilled blocks are |
| | removed from the active blocks. |
+------------------+--------------------------------------------------+
| Pct% | The percent full. InUse blocks / Total Blocks |
+------------------+--------------------------------------------------+
| Tracks | The number of tracks that are being used by the |
| | log. |
+------------------+--------------------------------------------------+
| BlksLog | The physical Log blocks per logical Log block. |
| | This field contains 1 unless spanned logging is |
| | used. |
+------------------+--------------------------------------------------+

SequenceNumber
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Rec | Each record written to the Log Areas is assigned |
| | an ascending sequence number. The last number |
| | assigned is provided here. |
+------------------+--------------------------------------------------+
| Block | Contains the assigned log track sequence number |
| | of the log record in the Log Area that is one |
| | number higher than the previous log track. |
| | |
| | This field is valid starting with Datacom r15.0. |
+------------------+--------------------------------------------------+

Logging
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Restart block | This field contains the number of Log blocks |
| scan | that the RESTART process, during |
| | Multi-User-Facility startup processing, would |
| | have to review to ensure all tasks are seen and |
| | processed. |
+------------------+--------------------------------------------------+
| Restart block | The Multi-User Facility takes into account the |
| redo | startup option LOGPEND, the current activity |
| | requests, and index and data buffers that are |
| | pipelined (write pended). From this |
| | information, a minimum number of Log blocks that |
| | the RESTART processing during |
| | Multi-User-Facility startup, needs to redo to |
| | ensure all index and data in the pipeline are |
| | completed. |
+------------------+--------------------------------------------------+
| Wait for log | An informational count of the times that a task |
| block | has to wait on access to the Log buffer that is |
| | used for adding Log records. |
+------------------+--------------------------------------------------+
| Wait for log | An informational count of the times a task |
| record | wanted to add a Log record, but had to wait on |
| | another task already in the process of adding a |
| | log record. |
+------------------+--------------------------------------------------+

Spill Status
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| RXX number | This is the number that is assigned to the next |
| | Recovery File (RXX) produced. |
+------------------+--------------------------------------------------+
| Cycle number | A cycle is a contiguous group of LXX blocks to |
| | be written to the Recovery File (RXX). If |
| | a spill is being done, then this cycle number |
| | represents the cycle being spilled. If a spill |
| | is not being done, then the cycle number |
| | represents the current unspilled LXX blocks, |
| | some or all of which become the next spilled |
| | cycle. |
+------------------+--------------------------------------------------+
| Last spill time | This field contains the date and time of the |
| | last spill or "No spills have occurred." |
+------------------+--------------------------------------------------+
| Blocks spillable | This field contains zero if currently spilling. |
| | Otherwise, it contains the number of blocks that |
| | are spillable at this point in time. |
+------------------+--------------------------------------------------+
| Spilling | Contains a YES to indicate that a spill has been |
| | prepared and is committed to start. |
+------------------+--------------------------------------------------+
| Blocks total | As a spill is prepared, this field is set to |
| | contain the number of blocks that are to be |
| | spilled. |
+------------------+--------------------------------------------------+
| Blocks done | As a spill is prepared, this field is set to |
| | zero. It is incremented as individual Log |
| | blocks are read from the Log to be copied to the |
| | Recovery File. |
+------------------+--------------------------------------------------+

Variable Logging
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Init as Variable | Indicates if the LXX was initialized as variable.|
+------------------+--------------------------------------------------+
| Buffer Used 1 | The number of times the first log-ahead buffer |
| | is activated. It occurs only when the single |
| | current buffer is full and no log-ahead buffers |
| | are in use. If activated, the buffer can |
| | contain only one record or a full block of |
| | records before it is written. |
+------------------+--------------------------------------------------+
| Buffer Used 2-4 | Count of times the second, third or fourth |
| | log-ahead buffer was activated. |
+------------------+--------------------------------------------------+
| Buffer Used 5-7 | Count of times the fifth, sixth or seventh |
| | log-ahead buffer was activated. |
+------------------+--------------------------------------------------+
| Buffer Used 8+ | Count of times 8 or more log-ahead buffers were |
| | activated. |
+------------------+--------------------------------------------------+
| Buffer Used Max | For variable logging, this field contains a |
| | count, if you have allocated more than 8 buffers.|
| | It tells you the maximum number of buffers that |
| | have actually been used. |
+------------------+--------------------------------------------------+
| Blocks Write 2-3 | Contains a count of the number of times the |
| | current log block was written with a chain of 2 |
| | or 3 log blocks in a single I/O. |
+------------------+--------------------------------------------------+
| Blocks Write 4-6 | Contains a count of the number of times the |
| | current log block was written with a chain of 4, |
| | 5 or 6 log blocks in a single I/O. |
+------------------+--------------------------------------------------+

Log Delay
+------------------+--------------------------------------------------+
| Comit Bad | If this MUF uses the X_LOG_DELAY Multi-User |
| | startup option, this column contains the count |
| | of times a task doing a transaction-ending |
| | command delayed for another task to write the |
| | LXX block but none did within the specified time |
| | limit. If this MUF does not use the X_LOG_DELAY |
| | Multi-User startup option, this column is 0. |
+------------------+--------------------------------------------------+
| Comit Good | If this MUF uses the X_LOG_DELAY Multi-User |
| | startup option, this column contains the count |
| | of times a task doing a transaction-ending |
| | command delayed for another task to write the |
| | LXX block and another did, therefore saving a |
| | possible LXX I/O. If this MUF does not use the |
| | X_LOG_DELAY Multi-User startup option, this |
| | column is 0. |
+------------------+--------------------------------------------------+
| Variable Wait | This is the count of times all log-ahead buffers |
| SMP | were full and a wait needed to occur for a |
| | current block to free one or more buffers. If |
| | this count is large, consider increasing the |
| | number of log-ahead buffers. This column |
| | indicates whether the log was subjected to an |
| | INIT with the variable specified as yes (Y) or |
| | no (N). |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCMEMDT

DCMEMDT Command

The DCMEMDT command displays the MUF_MEM_DETAIL Dynamic System Table


which contains information regarding the MUF memory pools.

Command Syntax

+------------------+--------------------------------------------------+
| DCMEMDT | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| MUFName | Name of the Multi-User Facility (MUF) specified |
| | in the Multi-user startup option or the MUF |
| | jobname. |
+------------------+--------------------------------------------------+
| Desc | A short description that can be blanks or |
| | repeated, as appropriate. For a list of these |
| | descriptions, refer to the information in the |
| | EOJ report. |
+------------------+--------------------------------------------------+
| Type | Value of 24 or 31, indicating whether memory is |
| | 24-bit or 31-bit. |
+------------------+--------------------------------------------------+
| Amount | Total memory allocated to this pool. |
+------------------+--------------------------------------------------+
| Occur | This column lists the number of occurrences of |
| | LUW, STME, STMR, and XCL (refer to the |
| | information in the EOJ report). |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCMEMSM

DCMEMSM Command

The DCMEMSM command displays the MUF_MEM_SUMMARY Dynamic System Table


which contains information regarding the MUF memory pools.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

+------------------+--------------------------------------------------+
| DCMEMSM | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | [ XSGroup name ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | |
| | This value can be also be set by issuing the |
| | SET DCMODE REGION command. |
| | |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Datacom address |
| | spaces on the current system. |
| | |
| | This value can also be set by issuing the |
| | SET DCMODE SYSTEM command. |
| | |
| | The current XSDATA profile setting for the |
| | command is honored. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSYStem | Display data for all Datacom address spaces for |
| XSData | all systems. This forces cross system data |
| | collection to be set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Jobname of the Multi-User Faciilty (MUF) |
| | indicated in the MUFname field |
+------------------+--------------------------------------------------+
| MUFName | Name of the Multi-User Facility (MUF) specified |
| | in the Multi-user startup option or the MUF |
| | jobname. |
+------------------+--------------------------------------------------+
| 24BitK | Number of 1024 segments allocated in 24-bit |
| | program memory. |
+------------------+--------------------------------------------------+
| 31BitM | Number of 1,048,576 segments allocated in 31-bit |
| | program memory. |
+------------------+--------------------------------------------------+
| 64BitM | Number of 1,048,576 segments allocated above the |
| | 64-bit bar. |
+------------------+--------------------------------------------------+
| 64BitLPage | Number of 1,048,576 segments above the bar |
| | backed by large pages. |
+------------------+--------------------------------------------------+
| PGM24BitK | This shows most but not all 24-bit program |
| | memory, divided by 1024 (in K). |
+------------------+--------------------------------------------------+
| PGM31BitK | This shows most but not all 31-bit program |
| | memory, divided by 1024 (in K). |
+------------------+--------------------------------------------------+
| Requests | The number of requests made to the MUF memory |
| | manager. This count includes both get memory |
| | and free memory requests. |
+------------------+--------------------------------------------------+
| OutOfMem | The number of times memory was requested but |
| | could not be honored from the MUF memory |
| | manager, because of insufficient available |
| | memory. |
+------------------+--------------------------------------------------+
XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCMRDF

DCMRDF Command

The DCMRDF command displays information about the Memory Resident


Data Facility. This data is information combined from the definitions
of the desired covered and virtual usage with the current covered and
virtual status. Four types of rows can exist to provide all the
information:

* The first type of row is a database level definition. This


definition serves as a default for all areas in the database
that have no specific matching area definition.

* The second type of row is for specific area definitions for


which the area has not yet been opened.

* The third type of row is a specific covered area that is open


or has been opened.

* The fourth type of row is a specific virtual area that is open


or has been opened.

Command Syntax

+------------------+--------------------------------------------------+
| DCMRDF | [ dbid ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DBID | The request database ID. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| Area | The name of the area. |
+------------------+--------------------------------------------------+
| Type | Contains VIRTUAL to represent a virtual base, or |
| | COVERED to represent a covered base. |
+------------------+--------------------------------------------------+
| Open | For database level definitions, or specific area |
| | definitions to unopened areas, either of which |
| | did not provide the FIRST or ACTIVE option |
| | specified, this field is blank. Otherwise, this |
| | field contains FIRST to indicate FIRST is to be |
| | used, or ACTIVE to indicate ACTIVE usage. |
+------------------+--------------------------------------------------+
| Size | The size for a database definition. |
+------------------+--------------------------------------------------+
| Blocks | This field contains blanks if a database level |
| | definition or an unopened specific area |
| | definition. Otherwise, it contains the number |
| | of blocks currently available for use for the |
| | specific area. |
+------------------+--------------------------------------------------+
| MaxBlks | This field contains blanks if a database level |
| | definition or an unopened specific area |
| | definition. Otherwise, it contains the number |
| | of blocks allocated for use for the specific |
| | area. |
+------------------+--------------------------------------------------+
| BgnBlk | Contains the percent of area block used when |
| | covered with FIRST option. Contains null if |
| | virtual or covered with the ACTIVE option. |
+------------------+--------------------------------------------------+
| HVBlock | This field contains blanks except for areas |
| | opened in a VIRTUAL database. This field |
| | contains the number of the last block in the |
| | virtual data set (High Virtual Block). |
+------------------+--------------------------------------------------+
| Dataspace | This field contains blanks for a database level |
| | definition or an unopened specific area |
| | definition. Otherwise, it contains: |
| | DATASPACE Area is in a data space |
| | ADDRSPACE Area is in normal address space memory|
| | 64-BIT Area is in 64-bit memory |
+------------------+--------------------------------------------------+
| Reads | The number of blocks in this covered/virtual |
| | area that are needed in a normal LXX, IXX, data |
| | buffers that are requested from MRDF. |
+------------------+--------------------------------------------------+
| MReads | This field contains the number of blocks that |
| | were read from the MRDF space instead of from |
| | DASD. |
+------------------+--------------------------------------------------+
| AReads | This field provides the number of blocks read |
| | from disk to support an active covered area that |
| | is open or has been opened. |
+------------------+--------------------------------------------------+
| NReads | This field contains the number of blocks read |
| | from DASD that are higher than the first covered |
| | blocks. |
+------------------+--------------------------------------------------+
| VWrites | For opened virtual areas, this is the number of |
| | times a block was written from the normal |
| | buffers to a MRDF buffer. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCMUFS

DCMUFS Command

The DCMUFS command displays Multi-User-Facility system information


for Datacom address spaces.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DCMUFs | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | [ XSGroup name ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | |
| | This value can be also be set by issuing the |
| | SET DCMODE REGION command. |
| | |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Datacom address |
| | spaces on the current system. |
| | |
| | This value can also be set by issuing the |
| | SET DCMODE SYSTEM command. |
| | |
| | The current XSDATA profile setting for the |
| | command is honored. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSYStem | Display data for all Datacom address spaces for |
| XSData | all systems. This forces cross system data |
| | collection to be set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| JobName | The z/OS Multi-user JOB Name. |
+------------------+--------------------------------------------------+
| MUFname | The Multi-User-Facility jobname. |
+------------------+--------------------------------------------------+
| Dirname | The directory (CXX) name being used by this MUF. |
+------------------+--------------------------------------------------+
| Nodename | The Datacom STAR Option node name. |
| | Otherwise, it is blank. |
+------------------+--------------------------------------------------+
| PC | The PC version as specified in the DBSYSID macro.|
| | Valid values are: |
| | |
| | PROD |
| | TEST |
+------------------+--------------------------------------------------+
| Release | The release number. |
+------------------+--------------------------------------------------+
| SP | The service pack number. |
+------------------+--------------------------------------------------+
| DD-Sec | Datadictionary security is being done through |
| | EXTERNAL security checking or INTERNAL |
| | datadictionary coding. |
+------------------+--------------------------------------------------+
| DQ-Sec | Dataquery security is being done |
| | through EXTERNAL security checking or INTERNAL |
| | Dataquery coding. |
+------------------+--------------------------------------------------+
| Enable-Date | The date that the MUF was enabled. |
+------------------+--------------------------------------------------+
| Enable-Time | The time that the MUF was enabled. |
+------------------+--------------------------------------------------+
| DBRATCICS | Security options for Datacom/DB |
| | under CICS. |
+------------------+--------------------------------------------------+
| DBRATSrvr | Security options for Datacom/DB |
| | under a server. |
+------------------+--------------------------------------------------+
| DBRATOthr | Security options for Datacom/DB |
| | under other circumstances. |
+------------------+--------------------------------------------------+
| DBSQLCICS | Security options for Datacom/DB SQL |
| | under CICS. |
+------------------+--------------------------------------------------+
| DBSQLSrvr | Security options for Datacom/DB SQL |
| | under a server. |
+------------------+--------------------------------------------------+
| DBSQLOthr | Security options for Datacom/DB SQL |
| | under other circumstances. |
+------------------+--------------------------------------------------+
| DQRATCICS | Security options for Dataquery |
| | under CICS. |
+------------------+--------------------------------------------------+
| DQRATOthr | Security options for Dataquery |
| | under other circumstances. |
+------------------+--------------------------------------------------+
| DQSQLCICS | Security options for Dataquery SQL |
| | under CICS. |
+------------------+--------------------------------------------------+
| DQSQLOthr | Security options for Dataquery SQL |
| | under other circumstances. |
+------------------+--------------------------------------------------+
| JobID | The z/OS Multi-user JOB ID. |
| | |
+------------------+--------------------------------------------------+
| SysName | The z/OS system name. |
| | |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Select | Invoke the DCDBASEs command to display the |
| | available databases. |
+------------------+--------------------------------------------------+
| DBases | Invoke the DCDBASEs command to display the |
| | available databases. |
+------------------+--------------------------------------------------+

Subcommands
+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCOPEN

DCOPEN Command

The DCOPEN command displays a list of open databases along with


the jobname that currently has the database open.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DCOPEN | [[ DBID ] dbid ] |
| | |
| | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | [ XSGroup name ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | |
| | This value can be also be set by issuing the |
| | SET DCMODE REGION command. |
| | |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Datacom address |
| | spaces on the current system. |
| | |
| | This value can also be set by issuing the |
| | SET DCMODE SYSTEM command. |
| | |
| | The current XSDATA profile setting for the |
| | command is honored. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSYStem | Display data for all Datacom address spaces for |
| XSData | all systems. This forces cross system data |
| | collection to be set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DBID | The request database ID. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Jobname of the Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| MUFname | Name of the Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| JobNode | Contains LOCAL in a non Datacom Database STAR |
| | Option MUF. In a Datacom Database STAR Option |
| | MUF, this field contains the Datacom Database |
| | STAR Option node name for the MUF that the |
| | application is connected to. |
+------------------+--------------------------------------------------+
| OpenJobn | The jobname of a job that has at least one URT |
| | open against a table in this database. |
+------------------+--------------------------------------------------+
| RunUnit | Contains the run-unit number for this job. |
+------------------+--------------------------------------------------+
| URTNum | Contains the internal User Requirements Table |
| | Number for the User Requirements Table with this |
| | database open. |
+------------------+--------------------------------------------------+
| URTDBID | Contains a database ID as it exists in the User |
| | Requirements Table (URT) of the application |
| | program. |
+------------------+--------------------------------------------------+
| Star | Indicates whether this database exists to |
| | support Datacom Database STAR |
| | Option services. |
+------------------+--------------------------------------------------+
| Remote | Indicates whether the database ID represents a |
| | database which resides at a remote MUF using |
| | Datacom/STAR. Star must be YES. |
+------------------+--------------------------------------------------+
| RemDBID | Contains blanks when the Remote field contains |
| | No. Otherwise, it contains the database ID as |
| | it is known at the MUF where the database |
| | resides. |
+------------------+--------------------------------------------------+
| RemNode | Contains blanks in a non Datacom Database |
| | STAR Option environment. It also contains blanks |
| | if this database is local or if REMOTE is NO. |
+------------------+--------------------------------------------------+
| Part | Indicates whether this base is part of a |
| | Datacom Database STAR Option |
| | partitioned database. |
+------------------+--------------------------------------------------+
| Rep | Indicates whether this base is part of a |
| | Datacom Database STAR Option |
| | replicated database. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCOPTION

DCOPTION Command

The DCOPTION command displays general startup options and their


values. A full description of these options is available in the
Datacom/DB Database and System Administration Guide.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DCOPTION | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | [ XSGroup name ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | |
| | This value can be also be set by issuing the |
| | SET DCMODE REGION command. |
| | |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Datacom address |
| | spaces on the current system. |
| | |
| | This value can also be set by issuing the |
| | SET DCMODE SYSTEM command. |
| | |
| | The current XSDATA profile setting for the |
| | command is honored. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSYStem | Display data for all Datacom address spaces for |
| XSData | all systems. This forces cross system data |
| | collection to be set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Jobname of the Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| Option | The name of the startup option. |
+------------------+--------------------------------------------------+
| Suboption | The suboption of the startup option. |
+------------------+--------------------------------------------------+
| Value | The assigned value. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes
This command performs an automatic address space switch to the
jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCPARCOL

DCPARCOL Command

The DCPARCOL command displays information about directory partition


columns.

Command Syntax

+------------------+--------------------------------------------------+
| DCPARCOL | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DirName | The directory (CXX) name being used by this MUF. |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| FullTbl | The table name of the full parent table. |
+------------------+--------------------------------------------------+
| Partns | Contains the number of partitions for this |
| | parent table. |
+------------------+--------------------------------------------------+
| Tbl | Contains the partition name. |
+------------------+--------------------------------------------------+
| Order | Indicates the table order within partitions. |
| | Specifies that this is the first partition, |
| | or the second, and so on. |
+------------------+--------------------------------------------------+
| NextTbl | Contains the table name of the next partition |
| | of this Parent table, in data value order. |
+------------------+--------------------------------------------------+
| PrevTbl | Contains the table name of the previous partition|
| | of this Parent table, in data value order. |
+------------------+--------------------------------------------------+
| ColSeq | Contains the column sequence within partitioning |
| | columns. |
+------------------+--------------------------------------------------+
| ColOffs | Contains the column offset into the row. |
+------------------+--------------------------------------------------+
| ColLen | Contains the column length being used. It is |
| | the entire field as stored in the data row. |
+------------------+--------------------------------------------------+
| Format | Contains the format of the data where: |
| | |
| | CH indicates character. |
| | DT indicates an SQL DATE. |
| | TM indicates an SQL TIME. |
| | TS indicates an SQL TIMESTAMP. |
| | NM indicates numeric. |
+------------------+--------------------------------------------------+
| Occurrence | Contains the Datadictionary occurrence name for |
| | the field. |
+------------------+--------------------------------------------------+
| ValLen | Contains the length of the highest value to |
| | reside in this partition. A length of zeros |
| | indicates the concept of high-value. Must |
| | match COLUMN_LENGTH when not character. If |
| | character, this is the length used to compare, |
| | such as a 100 byte character column, but only |
| | the first 25 bytes are to be compared. |
+------------------+--------------------------------------------------+
| HighValue | Contains a character representation of the |
| | highest value to reside in this partition |
| | when the format is not character. When it is |
| | character, this contains the actual high |
| | value and so might not be printable as is. |
| | Character data is left justified. Numeric |
| | data is right justified. If numeric data is |
| | signed, the right-most position will contain |
| | a minus sign for negative or a blank for |
| | positive. |
+------------------+--------------------------------------------------+

Line Commands
No line commands are defined by the &HelpMember command, however
other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCPRODS

DCPRODS Command

The DCPRODS command displays a list of products or features that


can be in use in the Datacom/DB system.

Command Syntax

+------------------+--------------------------------------------------+
| DCPRODs | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Product | The product that was allowed in the Multi-User |
| | startup option DATACOM. |
+------------------+--------------------------------------------------+
| Available | Specifies whether the product or feature was |
| | specified in the Multi-User startup option |
| | DATACOM. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCRATES

DCRATES Command

The DCRATES command displays information about


Datacom resource consumption.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DCRATEs | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | [ XSGroup name ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | |
| | This value can be also be set by issuing the |
| | SET DCMODE REGION command. |
| | |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Datacom address |
| | spaces on the current system. |
| | |
| | This value can also be set by issuing the |
| | SET DCMODE SYSTEM command. |
| | |
| | The current XSDATA profile setting for the |
| | command is honored. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSYStem | Display data for all Datacom address spaces for |
| XSData | all systems. This forces cross system data |
| | collection to be set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| JobName | The Datacom Job name. |
+------------------+--------------------------------------------------+
| MUFname | The Multi-User-Facility MUF name. |
+------------------+--------------------------------------------------+
| Intvl | The interval, in seconds, over which the rates |
| | were collected. |
+------------------+--------------------------------------------------+
| CPU-Used | Specifies the number of seconds of CPU time used |
| | by the Multi-User-Facility address space during |
| | the last completed time interval. |
+------------------+--------------------------------------------------+
| Requests | Specifies the number of Datacom/DB |
| | requests per second averaged over the last |
| | completed time interval. Note that data buffers |
| | include both normal and large size buffers. |
+------------------+--------------------------------------------------+
| Reads | Specifies the number of physical read I/O events |
| | per second averaged over the last completed time |
| | interval. This count includes the Directory |
| | (CXX), Log Area (LXX), Dual Log Area (NXX), all |
| | Index Areas (IXX...), and data areas (xxx...). |
+------------------+--------------------------------------------------+
| Writes | Specifies the number of physical write I/O |
| | events per second averaged over the last |
| | completed time interval. This count includes |
| | the Directory (CXX), Log Area (LXX), Dual Log |
| | Area (NXX), all Index Areas (IXX...), and data |
| | areas (xxx...). |
+------------------+--------------------------------------------------+
| IXX | Specifies the number of high level index (IXX) |
| | buffer references per second averaged over the |
| | last completed time interval. |
+------------------+--------------------------------------------------+
| DXX | Specifies the number of low level index (DXX) |
| | buffer references per second averaged over the |
| | last completed time interval. |
+------------------+--------------------------------------------------+
| Data | Specifies the number of data buffer references |
| | per second averaged over the last completed time |
| | interval. Note that data buffers include both |
| | normal and large size buffers. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCRCOPT

DCRCOPT Command

The DCRCOPT command displays the Datacom return codes from the
MUF_RC_DUMP_OPT dynamic system table.

Command Syntax

+------------------+--------------------------------------------------+
| DCRCOPT | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| MUFName | Name of the Multi-User Facility (MUF) specified |
| | in the Multi-user startup option or the MUF |
| | jobname. |
+------------------+--------------------------------------------------+
| ExtRC | Datacom/DB passes a return code, that is, an |
| | external return code, to the Request Area of a |
| | program in response to the program issuing a |
| | Datacom/DB command. Datacom/DB also issues |
| | return codes within Datacom/DB messages, that |
| | is, internal return codes. All non-blank |
| | external return codes have one or more associated|
| | internal return codes. If there is only one |
| | internal return code associated with the return |
| | code, it is not separately listed in the |
| | Datacom/DB Message Reference Guide since the |
| | description in that case of the external and |
| | internal return codes is the same. |
+------------------+--------------------------------------------------+
| IntRC | See the explanation of internal codes given in |
| | the description of EXTERNAL_CODE above. |
+------------------+--------------------------------------------------+
| DumpOpt | Valid values are: |
| | |
| | BUFFER - The Master List and buffers dump are |
| | generated. |
| | ML - A Master List dump with no buffer dump |
| | is generated. |
| | MINIMAL - A minimal dump is generated. A |
| | minimal dump is a small, tailored dump |
| | that is suitable for a few simple |
| | errors, for example, an invalid |
| | command. |
| | NONE - No dump is produced |
+------------------+--------------------------------------------------+
Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCREQS

DCREQS Command

The DCREQS command displays system statistics concerning requests


and pending requests.

Command Syntax

+------------------+--------------------------------------------------+
| DCREQs | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DB | Specifies the number of calls from an |
| | application program either directly or through |
| | another tool, such as SQL, that was shipped to |
| | the Multi-User-Facility. Blocked GETIT/GETPS |
| | requests are counted here as one request per |
| | block. |
+------------------+--------------------------------------------------+
| SQL | Specifies the number of requests that were made |
| | to the Multi-User-Facility of the SQL style. |
+------------------+--------------------------------------------------+
| Data Manager | Specifies the number of calls to the low-level |
| | Datacom/DB processor. Each request |
| | to the Multi-User-Facility that involves a RAAT |
| | or SAAT type command generates one data manager |
| | request. Each request involving an SQL request |
| | generates as many data manager requests as |
| | necessary to process the SQL request. |
+------------------+--------------------------------------------------+
| Record Locks | Specifies the number of times a record was |
| | locked. This includes exclusive control locks |
| | and, for SQL, share locks. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Pending | Specifies the number of tasks waiting on |
| | resources other than I/O when another task |
| | requested a resource. |
+------------------+--------------------------------------------------+
| Requests | Specifies the number of times that tasks waited |
| | on resources other than I/O and that there were |
| | other pending tasks waiting on resources. |
+------------------+--------------------------------------------------+
| Pct% | Specifies the percent of the total number of |
| | requests that have been pending. |
+------------------+--------------------------------------------------+
| Pct-of-Total | The graphic display of the percentage of the |
| | total number of requests that have been pending. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCRETCOD

DCRETCOD Command

The DCRETCOD command displays Multi-User-Facility return codes for


Datacom address spaces.

Command Syntax

+------------------+--------------------------------------------------+
| DCRETCOD | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| MUFname | The Multi-User-Facility name. |
+------------------+--------------------------------------------------+
| ExtRC | The external return code returned to caller. |
+------------------+--------------------------------------------------+
| IntRC | The internal return code returned to caller. |
+------------------+--------------------------------------------------+
| Count | Number of times the return code has occurred. |
+------------------+--------------------------------------------------+
| Text | Text associated with return code. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCSMP

DCSMP Command

The DCSMP command displays monitoring information relating to the


running of the Multi-User-Facility in SMP mode. Two types of
information exist.

The first type supplies information to tune the number of SMP tasks
and the count to start more. These fields include Posted 0 through
24+. Periodically, Datacom/DB samples the list of posted
tasks (unit of work) that are ready to run. At each sample, 1 is
added to one of the POSTED counters. The proportion of values in the
POSTED counters reflects the depth or the backlog of work outstanding.

The second type provides the number of lock contentions for each of the
SMP type internal locks. All locks are held for a minimum number
of instructions. Contention exists between one TCB that owns the
lock and another TCB that wants the lock when one of them needs an
exclusive lock. In this case, the second TCB must wait.

Command Syntax

+------------------+--------------------------------------------------+
| DCSMP | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Posted | Specifies the number of times the posted list |
| | entries were counted and the list contained nnn |
| | entries. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Resource | Specifies the name of the lock resource. |
+------------------+--------------------------------------------------+
| Conflicts | Specifies the number of lock contentions. |
+------------------+--------------------------------------------------+
| Pct% | The percent of total lock contentions. |
+------------------+--------------------------------------------------+
| Pct-of-Total | The graphic display of the percentage of total |
| | lock contentions. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| OPTions | Set and display command options. |
+------------------+--------------------------------------------------+
| EXTRact | Request that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable |
| | variable. The variable created or updated is |
| | named SYSV_OPTIONS_DCSMP. EXTRACT is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. EXTRACT can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+------------------+--------------------------------------------------+

OPTIONS Subcommand

Use the OPTIONS subcommand to set and display processing options.

OPTIONS Subcommand Format


+---------------+-----------------------------------------------------+
| OPTIONS | [options] |
+---------------+-----------------------------------------------------+

OPTIONS Parameter Values

The following table lists and explains the valid OPTIONS parameter
values. Any number of the values can be specified in any order.
The current settings of all options are always displayed in
response to the OPTIONS subcommand.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| BIZ | Blank If Zero. Do not display a resource line |
| | if the associated value is zero. |
| NOBIZ | No Blank If Zero. Display all resources. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_DCSMP. This keyword is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. The EXTRACT keyword can be |
| | specified alone or in combination with any other |
| | OPTIONS keyword. |
+---------------+-----------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCSMPTSK

DCSMPTSK Command

The DCSMPTSK command displays counts of times that each TCB selected
and performed a unit of work. A request provided Multi-User-Facility
once started is a unit of work.

Command Syntax

+------------------+--------------------------------------------------+
| DCSMPTSK | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| TaskID | Contains the number of the SMP task. |
+------------------+--------------------------------------------------+
| Active | Specifies if this SMP task is currently active. |
+------------------+--------------------------------------------------+
| Times-Used | Specifies the number of times this TCB was used |
| | to perform an SMP type unit-of-work. |
+------------------+--------------------------------------------------+
| Pct% | The percentage of the total of all TCB |
| | Times-used. |
+------------------+--------------------------------------------------+
| Used-Pct | The bar graph of Pct%. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCSQLCOD

DCSQLCOD Command

The DCSQLCOD command displays Multi-User-Facility SQL codes for


Datacom address spaces.

Command Syntax

+------------------+--------------------------------------------------+
| DCSQLCOD | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| MUFname | The Multi-User-Facility name. |
+------------------+--------------------------------------------------+
| SQLCode | SQL code. |
+------------------+--------------------------------------------------+
| Count | Number of times the SQL code has occurred. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCSQLMSC

DCSQLMSC Command

The DCSQLMSC command displays the Multi-User-Facility SQL


miscellaneous statistics for Datacom address spaces.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DCSQLMSC | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | [ XSGroup name ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | |
| | This value can be also be set by issuing the |
| | SET DCMODE REGION command. |
| | |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Datacom address |
| | spaces on the current system. |
| | |
| | This value can also be set by issuing the |
| | SET DCMODE SYSTEM command. |
| | |
| | The current XSDATA profile setting for the |
| | command is honored. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSYStem | Display data for all Datacom address spaces for |
| XSData | all systems. This forces cross system data |
| | collection to be set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The Datacom address space job name. |
+------------------+--------------------------------------------------+
| MUFname | The Multi-User-Facility name. |
+------------------+--------------------------------------------------+
| CacheReuse | Count of times a procedure definition had to be |
| | purged from the LRU (Least Recently Used) |
| | procedure definition cache in order to make room |
| | for a newly requested definition. You should |
| | enlarge the cache size specified in the |
| | PROCEDURE Multi-User startup option until this |
| | number is as small as possible. If the number |
| | is zero, either procedures are not in use or |
| | every procedure definition used so far fits into |
| | the cache. |
+------------------+--------------------------------------------------+
| CallProc | Count of times a procedure was executed because |
| | of a CALL PROCEDURE SQL statement. |
+------------------+--------------------------------------------------+
| Trigger | Count of times a procedure was executed because |
| | of a triggered event. |
+------------------+--------------------------------------------------+
| Queued | Count of times a procedure needing to execute |
| | was placed on a queue because no procedure TCB |
| | was available. Used to tune the number of |
| | procedure TCBs. |
+------------------+--------------------------------------------------+
| GenSQL | Count of SQL statements executed |
| | by a procedure. |
+------------------+--------------------------------------------------+
| Failures | Count of times a procedure failed due to some |
| | type of abend in the procedure. |
+------------------+--------------------------------------------------+
| Nests | Count of times a procedure was executed when it |
| | was caused by another procedure SQL statement. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCSQLPRC

DCSQLPRC Command

The DCSQLPRC command displays the Multi-User-Facility SQL


procedure detail information for Datacom address spaces.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DCSQLPRC | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | [ XSGroup name ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | |
| | This value can be also be set by issuing the |
| | SET DCMODE REGION command. |
| | |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Datacom address |
| | spaces on the current system. |
| | |
| | This value can also be set by issuing the |
| | SET DCMODE SYSTEM command. |
| | |
| | The current XSDATA profile setting for the |
| | command is honored. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSYStem | Display data for all Datacom address spaces for |
| XSData | all systems. This forces cross system data |
| | collection to be set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | The Datacom address space job name. |
+------------------+--------------------------------------------------+
| MUFName | The Multi-User-Facility name. |
+------------------+--------------------------------------------------+
| ProcName | The procedure name. |
+------------------+--------------------------------------------------+
| Starts | The procedure starts. |
+------------------+--------------------------------------------------+
| Seconds | The number of seconds of execution, rounded up |
| | to the next second. |
+------------------+--------------------------------------------------+
| Statements | The SQL statements. |
+------------------+--------------------------------------------------+
| Failures | The procedure failures. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCSQLSEQ

DCSQLSEQ Command

The DCSQLSEQ command displays the Multi-User-Facility SQL sequence


number for Datacom address spaces.

Command Syntax

+------------------+--------------------------------------------------+
| DCSQLSEQ | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| MUFname | The Multi-User-Facility name. |
+------------------+--------------------------------------------------+
| SQLSequence | SQL sequence number. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCSTATS

DCSTATS Command

The DCSTATS command displays internal Multi-User-Facility statistics.

Command Syntax

+------------------+--------------------------------------------------+
| DCSTATS | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Breaks | Specifies the number of times the startup option |
| | BREAK occurred to cause a task to allow a task |
| | switch. |
+------------------+--------------------------------------------------+
| Short I/O Memory | Times I/O restricted in z/OS due to 24_bit |
| | memory shortage. |
+------------------+--------------------------------------------------+
Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Type | Read n |
| | During sequential GETIT/GETPS, CBS, and ADDIT |
| | processing, it is possible that |
| | Datacom/DB would choose to read multiple |
| | blocks with one EXCP. |
| | |
| | Write n |
| | With pipelining, multiple blocks in an area |
| | frequently need to be written. If these |
| | blocks are physically close on DASD, |
| | Datacom/DB attempts to write |
| | more than one at a time. |
+------------------+--------------------------------------------------+
| Count | Read n |
| | This counter reflects the number of times |
| | that n blocks were read. |
| | |
| | Write n |
| | This counter reflects the number of times |
| | that n blocks could be written together in |
| | one EXCP. |
+------------------+--------------------------------------------------+
| Pct% | The percent of total reads or writes. |
+------------------+--------------------------------------------------+
| Pct-of-Total | The graphic display of the percentage of total |
| | reads or writes. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCSTATSM

DCSTATSM Command

The DCSTATSM command displays MUF internal statistics from the


MUF_INTERNAL_STATS table.

Command Syntax

+------------------+--------------------------------------------------+
| DCSTATSM | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

Miscellaneous
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Breaks Done | Number of times the startup option BREAK |
| | occurred to cause a task to allow a task switch. |
| | It does not indicate if another task of equal or |
| | higher priority was ready to run and was |
| | dispatched. |
+------------------+--------------------------------------------------+
| IO Memory Short | Times I/O restricted in z/OS due to 24-bit |
| | memory shortage. |
+------------------+--------------------------------------------------+
| Defrag | Contains the count of the number of times |
| Readbackward | backwards processing (such as LOCBR) interrupted |
| | an active DBUTLTY DEFRAG function. |
+------------------+--------------------------------------------------+
| IO DASD Retry | Count of times the operating system required |
| | Datacom to reissue a physical I/O because of a |
| | "retry" return code. |
+------------------+--------------------------------------------------+
| MRDF IXX Direct | Contains the count of times the MRDF facility |
| | referenced an IXX block directly, without moving |
| | it to an IXX buffer. |
+------------------+--------------------------------------------------+

XCF send failures due to:


+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Buffer Shortage | Count of times an XCF message send failed due to |
| | shortage of buffers resulting in a retry. |
+------------------+--------------------------------------------------+
| All Paths Busy | Count of times an XCF message send failed |
| | because all XCF signalling paths were busy |
| | resulting in a retry. |
+------------------+--------------------------------------------------+
| Environmental | Count of times an XCF message send failed for |
| Error | environmental reasons other than paths busy or |
| | too few message buffers resulting in a retry. |
+------------------+--------------------------------------------------+
| XCF Subsys | Count of times an XCF message send failed |
| Failure | the MVS XCF component failed. |
+------------------+--------------------------------------------------+
| Retry Limit | Count of the number of XCF messages for which |
| | the retry limit was exceeded and therefore had |
| | to be queried for action by a subtask. |
+------------------+--------------------------------------------------+
| MUF Rejected | Count of messages received by MUF with |
| Message | characteristics which made them unacceptable for |
| | processing. |
+------------------+--------------------------------------------------+

Index Queue
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Current Depth | Current number of unprocessed entries in the |
| | index queue. |
+------------------+--------------------------------------------------+
| Max Depth | Maximum number of unprocessed entries in the |
| | index queue for the life of this MUF. |
+------------------+--------------------------------------------------+
| Current Unique | Contains the current number of unique DBIDs with |
| DBIDs | unprocessed entries in the index queue. |
+------------------+--------------------------------------------------+
| Max Unique DBIDs | Contains the maximum number of unique DBIDs with |
| | unprocessed entries in the index queue for the |
| | life of this MUF. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCSYSOUT

DCSYSOUT Command

The DCSYSOUT command displays information about the SYSOUT


Multi-User startup option that directs diagnostic and tracing
information to SYSOUT files instead of to the Statistics and
Diagnostics Area (PXX).

Command Syntax

+------------------+--------------------------------------------------+
| DCSYSOUT | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| MUFName | The Multi-User-Facility name. |
+------------------+--------------------------------------------------+
| DDName | Name of the directed output. |
+------------------+--------------------------------------------------+
| Routed | The procedure starts. |
+------------------+--------------------------------------------------+
| Outlim | If the SYSOUT_NAME output is redirected to |
| | another SYSOUT, this is the name of that other |
| | SYSOUT. If the SYSOUT_NAME is not redirected to |
| | another SYSOUT, the ROUTED_NAME is blanks. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCSYSTEM

DCSYSTEM Command

The DCSYSTEM command displays system statistics about the


Multi-User-Facility.

Command Syntax

+------------------+--------------------------------------------------+
| DCSYSTEM | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

Requests
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Total DB | The number of calls from an application program |
| | either directly or through another tool, such as |
| | SQL, which was shipped to the |
| | Multi-User-Facility. Blocked GETIT/GETPS |
| | requests are counted here as one request per |
| | block. |
+------------------+--------------------------------------------------+
| Total SQL | Specifies the number of requests that were made |
| | to the Multi-User-Facility of the SQL style. |
+------------------+--------------------------------------------------+

I/Os
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Read | Specifies the number of physical I/Os (EXCPs) |
| | that have been done to read data from DASD. |
+------------------+--------------------------------------------------+
| Write | Specifies the number of physical I/Os (EXCPs) |
| | that have been done to write memory data to |
| | DASD. |
+------------------+--------------------------------------------------+

Index Queue
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Processed | The number of index queue entries processed. |
+------------------+--------------------------------------------------+

Waits
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Task | Specifies the number of times that a task had to |
| | wait on the completion of another task. This is |
| | done when a secondary conflict exists and the |
| | task needs to wait for a commit or rollback of |
| | the task last maintaining a data record. |
+------------------+--------------------------------------------------+
| Request | Specifies the number of times that a task had to |
| | wait on an active request of another task. |
+------------------+--------------------------------------------------+
| Spill | Specifies the number of times that a task had to |
| | wait on the completion of a spill. This occurs |
| | when a log has no space to add records until a |
| | spill is completed and space is made available. |
+------------------+--------------------------------------------------+
| Accounting | Specifies the number of times that a task had to |
| | wait when adding a record to an Accounting |
| | buffer because the Accounting buffer was full. |
+------------------+--------------------------------------------------+
| Security | Specifies the number of times that a task had to |
| | wait on security checking. This can only occur |
| | with internal (kernel) (SXX) security or with |
| | SQL GRANT/REVOKE security. |
+------------------+--------------------------------------------------+
| Indirect I/O | Specifies the number of times a request needed |
| | to wait on a buffer that was in an I/O status. |
| | The I/O may have been started by another task, |
| | or possibly by this task in an asynchronous |
| | mode. |
+------------------+--------------------------------------------------+
| Primary lock | Specifies the number of times that a task |
| | requested a record level lock that was not |
| | available. |
| | |
| | ( Primary exclusive control conflicts ) |
+------------------+--------------------------------------------------+
| Secondary | Specifies the number of times a record lock was |
| conflict | attempted where it was not currently available |
| | because the record was subject to transaction |
| | backout. |
| | |
| | ( Secondary exclusive control conflicts ) |
+------------------+--------------------------------------------------+

Log Writes
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Control | Specifies the number of times the Log control |
| | block was written. |
+------------------+--------------------------------------------------+
| Full | Specifies the number of times the Log buffer |
| | containing logged data was written when it was |
| | considered full. This count is the number of |
| | LXX blocks used. |
+------------------+--------------------------------------------------+
| Command | Specifies the number of times the Log buffer |
| | containing logged data was written because of a |
| | command. Commands that cause transaction |
| | boundaries (COMIT, LOGCP, LOGCR, ROLBK, CLOSE) |
| | are always written. The ADDIT, DELET, and UPDAT |
| | maintenance commands are only written if the |
| | table definition indicates writes, the URT |
| | indicates writes, or the Multi-User-Facility |
| | startup option LOGPEND indicates no pipelining. |
| | Optional commands are LOGIT and LOGDW. Some |
| | internal system commands can also write the Log |
| | block prior to full. Comparing the ratios of |
| | COMMAND WRITE to BUFFER FULL WRITE I/O can be |
| | used to attempt tuning by reducing the number |
| | of LXX writes. |
+------------------+--------------------------------------------------+
| Other | Specifies the number of times a non-full Log |
| | block had to be written to support RESTART when |
| | an index or data block had to be written. |
+------------------+--------------------------------------------------+
| Trans Backout | Specifies the number of times a Log block was |
| | written during a transaction or request backout. |
+------------------+--------------------------------------------------+
| Pend | Specifies the number of writes to an index or |
| | data buffer due to the setting of the startup |
| | option LOGPEND. |
+------------------+--------------------------------------------------+
| Percent Full | The highest percent full of the Log Areas |
| | reached. |
+------------------+--------------------------------------------------+
| Two Phase | The number of I/Os done to the Log Areas in |
| | support of the Datacom Database |
| | STAR Option two-phase commit processing. |
+------------------+--------------------------------------------------+

Miscellaneous
+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Seq Read Ahead | Specifies the number of times a read-ahead I/O |
| | was done in support of the GETIT and GETPS |
| | commands. |
+------------------+--------------------------------------------------+
| Deleted Blocks | Specifies the number of times the last entry in |
| | an index block was deleted. |
+------------------+--------------------------------------------------+
| No Backout Buffer| Specifies the number of times that a task was in |
| | transaction or request backout, but all LOGPOOL |
| | buffers were not available. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCTABLES

DCTABLES Command

The DCTABLES command displays information about every table in the


Directory.

Command Syntax

+------------------+--------------------------------------------------+
| DCTABLEs | [ dbid ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DBID | The request database ID. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| Area | The name of the area. |
+------------------+--------------------------------------------------+
| Table | The DATACOM-NAME attribute-value of the table. |
+------------------+--------------------------------------------------+
| TableID | The internal table identifier for this table. |
+------------------+--------------------------------------------------+
| Occurrence | The Datadictionary entity-occurrence name of |
| | this table. |
+------------------+--------------------------------------------------+
| Records | The number of records in the table. |
+------------------+--------------------------------------------------+
| Version | Specifies the version of the Datadictionary |
| | occurrence of this table. |
+------------------+--------------------------------------------------+
| Authid | The Authid value for this table. |
+------------------+--------------------------------------------------+
| SQLIntent | The status of the SQL. |
| | Possible values are: |
| | |
| | FULL - FULL SQL access. |
| | |
| | READONLY - SQL Read-Only. |
| | |
| | NONE - No SQL access is allowed. |
| | |
| | UNKNOWN - The structure was cataloged |
| | before the SQL INTENT option |
| | was supported. |
| | |
| | This field is valid starting with Datacom r15.0. |
+------------------+--------------------------------------------------+
| SQLName | The SQL name for this table. |
+------------------+--------------------------------------------------+
| Status | The status of the occurrence. |
+------------------+--------------------------------------------------+
| DD-DBID | The database identifier of the Datadictionary |
| | that last cataloged this definition to the |
| | Directory (CXX). |
+------------------+--------------------------------------------------+
| New | Specifies whether the DBID was changed using the |
| | NEWDBID option during a LOAD AREA=CXX or |
| | CXXMAINT OPTION=DDPROD utility. |
+------------------+--------------------------------------------------+
| TableLoad | Specifies whether the table is loaded. |
+------------------+--------------------------------------------------+
| IndexLoad | Specifies whether the index is loaded. |
+------------------+--------------------------------------------------+
| Restricted | If this table is partitioned, this field |
| | indicates whether users can access the |
| | Child table directly, YES or NO. If this table |
| | is not partitioned, this field is null. |
+------------------+--------------------------------------------------+
| MovetoPart | If this table is partitioned, this column |
| | indicates whether an update is allowed to move a |
| | row to a different partition, YES or NO. If |
| | table is not partitioned, this field is null. |
+------------------+--------------------------------------------------+
| EncrType | Type of encryption to be used. |
| | Possible values are: |
| | |
| | NONE - No Encryption. |
| | |
| | DB Basic - Basic encryption performed by |
| | Datacom/DB with no key management.|
| | |
| | EKM - Encryption and key management |
| | performed by EKM. |
| | |
| | DB Mixed - Encryption performed by Datacom/DB|
| | on a key provided by EKM. |
+------------------+--------------------------------------------------+
| EncrMethod | Method of encryption to be used. |
| | Possible values are: |
| | |
| | NONE |
| | AES-128 |
| | AES-192 |
| | AES-256 |
+------------------+--------------------------------------------------+
| Trigger | Indicates whether the table has one or more SQL |
| | triggers. |
+------------------+--------------------------------------------------+
| Partition | Indicates whether the table is a partition. |
+------------------+--------------------------------------------------+
| FullName | If this is a partition, this is the Full Parent |
| | name. |
+------------------+--------------------------------------------------+
| FullParSQLauth | If this is a partition, this is the Full Parent |
| | SQL AUTHID. |
+------------------+--------------------------------------------------+
| FullParSQLname | If this is a partition, this is the Full Parent |
| | SQL name. |
+------------------+--------------------------------------------------+
| AnyName | If this is a partition, this is the Any Parent |
| | name. |
+------------------+--------------------------------------------------+
| AnyParSQLauth | If this is a partition, this is the Any Parent |
| | SQL AUTHID. |
+------------------+--------------------------------------------------+
| AnyParSQLname | If this is a partition, this is the Any Parent |
| | SQL name. |
+------------------+--------------------------------------------------+
| TVer | Contains the table version (generation level) |
| | of the table. |
| | |
| | This field is valid starting with Datacom r15.0. |
+------------------+--------------------------------------------------+

Line Commands
The following table lists the line commands defined by the
&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Columns | Invokes the DCCOLUMN command for the current |
| | DBID and TABLE. |
+------------------+--------------------------------------------------+
| Elements | Invokes the DCELEMEN command for the current |
| | DBID and TABLE. |
+------------------+--------------------------------------------------+
| Keys | Invokes the DCKEYS command for the current |
| | DBID and TABLE. |
+------------------+--------------------------------------------------+
| Fields | Invokes the DCKEYFLD command for the current |
| | DBID and TABLE. |
+------------------+--------------------------------------------------+
| Requests | Invokes the DCTABREQ command for the current |
| | DBID and TABLE. |
+------------------+--------------------------------------------------+
| Select | Displays detailed information about the selected |
| | table. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCTABREQ

DCTABREQ Command

The DCTABREQ command displays table level information about the number
and types of requests being processed by this Multi-User-Facility.
This command can display request information since the
Multi-User-Facility has started or the current interval.

Command Syntax

+------------------+--------------------------------------------------+
| DCTABREQ | [ dbid ] [ Total | Interval | Sample ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+
| Interval | Display values for the interval. |
+------------------+--------------------------------------------------+
| Total | Display values as totals since the MUF started. |
+------------------+--------------------------------------------------+
| Sample | Display values as totals since the MUF started |
| | on the initial display. On each refresh, |
| | display interval values. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Interval | The elapsed time interval for the current value. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| Area | The name of the area. |
+------------------+--------------------------------------------------+
| Table | The name of the table. |
+------------------+--------------------------------------------------+
| Requests | Specifies the number of data manager requests |
| | made against this table. |
+------------------+--------------------------------------------------+
| Adds | Specifies the number of rows that were added to |
| | this table. As a measure of work done, it |
| | includes adds attempted but failed and also adds |
| | that were reversed during transaction backout. |
+------------------+--------------------------------------------------+
| Deletes | Specifies the number of rows that were deleted |
| | from this table. It includes rows that were |
| | deleted during transaction backouts reversing an |
| | add. |
+------------------+--------------------------------------------------+
| Reads | Specifies the number of data read type requests |
| | against this table. |
+------------------+--------------------------------------------------+
| Updates | Specifies the number of updates to this table. |
| | It includes updates that were made during |
| | transaction backouts reversing updates or |
| | deletes. |
+------------------+--------------------------------------------------+
| BegDate | The date of the MUF enable. |
+------------------+--------------------------------------------------+
| BegTime | The time of the MUF enable. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands


+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Columns | Invokes the DCCOLUMN command for the current |
| | DBID and TABLE. |
+------------------+--------------------------------------------------+
| Elements | Invokes the DCELEMEN command for the current |
| | DBID and TABLE. |
+------------------+--------------------------------------------------+
| Keys | Invokes the DCKEYS command for the current DBID |
| | and TABLE. |
+------------------+--------------------------------------------------+
| Fields | Invokes the DCKEYFLD command for the current |
| | DBID and TABLE. |
+------------------+--------------------------------------------------+
| Table | Invokes the DCTABLES command for the current |
| | DBID and TABLE. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+
| OPTions | Set and display command options. |
+------------------+--------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable |
| | The variable created or updated is named |
| | SYSV_OPTIONS_DCTABREQ. EXTRACT is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. EXTRACT can be specified |
| | alone or in combination with any other OPTIONS |
| | keywords. |
+------------------+--------------------------------------------------+

OPTIONS Subcommand

Use the OPTIONS subcommand to set and display processing options.

OPTIONS Subcommand Format

+---------------+-----------------------------------------------------+
| OPTIONS | [options] |
+---------------+-----------------------------------------------------+

OPTIONS Parameter Values

The following table lists and explains the valid OPTIONS parameter
values. Any number of the values can be specified in any order.
The current settings of all options are always displayed in
response to the OPTIONS subcommand.

+---------------+-----------------------------------------------------+
| Value | Explanation |
+---------------+-----------------------------------------------------+
| Interval | Display values for the interval. |
+---------------+-----------------------------------------------------+
| Total | Display values as totals since the MUF started. |
+---------------+-----------------------------------------------------+
| Sample | Display values as totals since the MUF started on |
| | the initial display. On each refresh, display |
| | interval values. |
+---------------+-----------------------------------------------------+
| EXTRact | Requests that the current option settings be |
| | extracted into a TSO CLIST or REXX EXEC variable. |
| | The variable created or updated is named |
| | SYSV_OPTIONS_DCTABREQ. This keyword is only |
| | valid when the product is running under a TSO |
| | CLIST or REXX EXEC. The EXTRACT keyword can be |
| | specified alone or in combination with any other |
| | OPTIONS keyword. |
+---------------+-----------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCTASKS

DCTASKS Command

The DCTASKS command displays information about Datacom tasks.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DCTASKs | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | [ XSGroup name ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+
Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | |
| | This value can be also be set by issuing the |
| | SET DCMODE REGION command. |
| | |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Datacom address |
| | spaces on the current system. |
| | |
| | This value can also be set by issuing the |
| | SET DCMODE SYSTEM command. |
| | |
| | The current XSDATA profile setting for the |
| | command is honored. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSYStem | Display data for all Datacom address spaces for |
| XSData | all systems. This forces cross system data |
| | collection to be set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Jobname of the Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| MUFname | The name of the Multi-User Facility specified |
| | on the MUFNAME= startup option, or the |
| | Multi-User Facility job name. |
+------------------+--------------------------------------------------+
| TaskJobn | The name of the job currently in the task area. |
| | Names starting with an asterisk (*) are internal |
| | to Datacom/DB. |
+------------------+--------------------------------------------------+
| TaskNum | The number of the task area being used for this |
| | request, also known as the RWTSA number. The |
| | low numbers are allocated for user application |
| | based upon the TASKS Multi-User-Facility startup |
| | option. Next are Datacom Database |
| | Server Option task areas, if any, followed by |
| | internal Datacom/DB system task |
| | areas. |
+------------------+--------------------------------------------------+
| Owner | If the status is WAIT E/C, then the number of |
| | the task that owns the lock is reported. Note |
| | that some locks have an owner task that is |
| | higher than the displayable tasks. This is |
| | correct and necessary for correct processing |
| | because these locks belong to |
| | Datacom/DB, not a specific task area. |
+------------------+--------------------------------------------------+
| EXCPs | The number of physical I/O events performed by |
| | this task, starting when the request is accepted |
| | by the Multi-User-Facility. |
+------------------+--------------------------------------------------+
| RunUnit | The internal number assigned by |
| | Datacom/DB to each Datacom job. |
| | This number is reported in various possible |
| | messages related to the job. |
+------------------+--------------------------------------------------+
| RSeqNum | The internal request sequence number. It starts |
| | at one when the Multi-User-Facility starts and |
| | is incremented for each request. It wraps as |
| | necessary. It is typically used to verify that |
| | the system is performing new work and to |
| | determine if a long-running user application is |
| | looping. The entire number, if less than 6 |
| | digits or else the low order 6 digits, can be |
| | used in the REQABORT utility to cancel a |
| | request, if desired. |
+------------------+--------------------------------------------------+
| Command | The five-character record-at-a-time or |
| | set-at-a-time command being executed or last |
| | executed. This field can contain certain |
| | internal commands that are only to be used by |
| | Technical Support. |
+------------------+--------------------------------------------------+
| Status | The current status of a task area is the same as |
| | is documented for the console status command. |
| | For details, see the COMM STATUS information in |
| | the Datacom/DB DBUTLTY Reference |
| | Guide. |
+------------------+--------------------------------------------------+
| Duration | The duration of the current request. |
+------------------+--------------------------------------------------+
| Tran | The CICS transaction name. |
+------------------+--------------------------------------------------+
| Term | The CICS terminal name. |
+------------------+--------------------------------------------------+
| Opid | The CICS operator ID. |
+------------------+--------------------------------------------------+
| Ctask | The CICS task number. |
+------------------+--------------------------------------------------+
| DBID | The database identifier. |
+------------------+--------------------------------------------------+
| Tbl | The table name. |
+------------------+--------------------------------------------------+
| UserData | The user information associated with the task. |
| | For record-at-a-time and set-at-a-time commands |
| | this data is passed by the user application |
| | program. When running a transparency, the |
| | transparency provides the information. Requests |
| | that are a part of SQL contain a variety of |
| | values. The format and content from all sources |
| | is totally unpredictable. |
+------------------+--------------------------------------------------+
| OptionalId | For CICS transactions, contains the transaction |
| | ID, terminal ID, operator ID, and sequence |
| | number. For Datacom Server, contains the |
| | logical terminal name. For DBUTLTY, contains |
| | literal "DBUTLTY" followed by the DBUTLTY |
| | utility function. Otherwise, this field is blank.|
+------------------+--------------------------------------------------+
| Reference | The number of index and data buffers referenced |
| | by this task, starting when the request is |
| | accepted by the Multi-User-Facility. |
+------------------+--------------------------------------------------+
| TSeqNum | Provides the transaction sequence number if the |
| | current task is in a transaction, or provides |
| | blanks if the current task is not in a |
| | transaction. |
+------------------+--------------------------------------------------+
| TranTime | Provides the duration of the transaction if |
| | the current task is in a transaction, or |
| | provides blanks if the current task is not |
| | in a transaction. The format of the duration |
| | is similar to the current request in that it |
| | is provided as mmm:ss, except that a time of |
| | zero is set to all blanks and a time greater |
| | than 999 minutes is set to +++:++. |
+------------------+--------------------------------------------------+
| MUFPlex | The MUFplex number at which the task owning a |
| | row or value lock resides, if this is a remote |
| | wait for exclusive control. |
+------------------+--------------------------------------------------+
| Value | Provides a character string of the row lock or |
| | value lock upon which is being waited, similar |
| | in format to the console STATUS function. The |
| | first six characters of the lock value are |
| | provided in the status after WAIT E/C. |
+------------------+--------------------------------------------------+
| RunTime | The amount of time this request has been |
| | running, minus the amount of time it has been in |
| | a Datacom controlled wait. The format is |
| | mmm:ss, where mmm is minutes and ss is seconds. |
+------------------+--------------------------------------------------+
| CPUTime | Is the total CPU time for this request if you |
| | have chosen to keep track of CPU time by |
| | specifying YES for the cpu-time parameter on the |
| | ACCTPRM Multi-User startup option. The format is |
| | mmm:ss, where mmm is minutes and ss is seconds. |
| | Otherwise this column is null. For more |
| | information, see the performance note for |
| | cpu-time in the information about the ACCTPRM |
| | Multi-User startup option in the Datacom/DB |
| | Database and System Administration Guide. |
| | Because CPU time is only computed |
| | periodically, tasks that are actively running |
| | might not include all of their CPU time. |
+------------------+--------------------------------------------------+
| WaitDur | If this task is currently waiting, this column |
| | contains the total amount of time since this wait|
| | began. The format is mmm:ss, where mmm is minutes|
| | and ss is seconds. If the task is not in a wait, |
| | this column is null. |
+------------------+--------------------------------------------------+
| WaitTime | The cumulated time this request was not set to |
| | running and was formally set to waiting. This |
| | time starts at zero when each request is started |
| | and is accumulated for each wait until the |
| | request ends. For example if a request was an |
| | ADDIT and it drove a total of 3 I/O events, the |
| | WAIT_TIME during or after the first I/O would be |
| | for that I/O alone. The WAIT_TIME after the 3rd |
| | I/O would be the summation of the wait for the |
| | first plus second plus third. |
+------------------+--------------------------------------------------+
| UserPath | The path of the request. Valid values are: |
| | |
| | LOCAL - The connection was generated on the same |
| | system as the MUF and the path was not |
| | XCF or CCI. |
| | XCF - The connection was generated using MVS |
| | XCF as the communication protocol. |
| | CCI - The connection was generated using |
| | CCI as the communication protocol. |
+------------------+--------------------------------------------------+
| UserSyst | Indicates the MVS system name from where the |
| | user application is connected. |
+------------------+--------------------------------------------------+
| UserJbid | Indicates the MVS JOBID for the user application |
| | connected to the MUF. It will be blanks when |
| | the task is internal to the MUF, such as the |
| | system tasks, like accounting. |
+------------------+--------------------------------------------------+
| EOJ | Indicates the EOJ_OK option setting. The EOJ_OK |
| | option allows MUF to EOJ without the |
| | application closing all URTs. |
| | |
| | Possible values are: |
| | Y - Reflects the URT DBURSTR macro parameter |
| | EOJ_OK. |
| | N - Reflects the URT DBURSTR macro parameter |
| | EOJ_OK. |
| | S - Indicates MUF EOJ_OK S=YES has been set |
| | for this Datacom Server task. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Cancel | Issues an MVS modify command to cancel the |
| | task. |
| | Command: "F jobname,REQABORT rseqnum |
+------------------+--------------------------------------------------+

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| Dbase | Displays open databases for the task. |
+------------------+--------------------------------------------------+
| TRace | Invokes the DCTRACE command selecting the |
| | current TASK#. |
+------------------+--------------------------------------------------+
Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCTCBSRB

DCTCBSRB Command

The DCTCBSRB command displays the MUF EOJ TCB/SRB use statistics.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DCTCBSRB | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | [ XSGroup name ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+
Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | |
| | This value can be also be set by issuing the |
| | SET DCMODE REGION command. |
| | |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Datacom address |
| | spaces on the current system. |
| | |
| | This value can also be set by issuing the |
| | SET DCMODE SYSTEM command. |
| | |
| | The current XSDATA profile setting for the |
| | command is honored. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSYStem | Display data for all Datacom address spaces for |
| XSData | all systems. This forces cross system data |
| | collection to be set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Jobname of the Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| MUFName | Name of the Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| TaskType | The type of task. Valid values are: |
| | MAIN The main MUF Task |
| | SMP The SMP subtask |
| | SUB For other subtasks |
+------------------+--------------------------------------------------+
| PGMName | Name of the program using this TCB or SRB. |
+------------------+--------------------------------------------------+
| SeqNum | A sequence number which uniquely identifies a |
| | task where more than one share the same program |
| | name (for example, DBSMPPR). |
+------------------+--------------------------------------------------+
| TimesUsed | The number of times an internal unit of work |
| | was performed by this task. |
+------------------+--------------------------------------------------+
| CPUUsed | The total CPU seconds used by this task for the |
| | life of this Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| PostedCount | Lists the number of times individual TCBs or SRBs|
| | went into a wait (no work to do) and were posted |
| | to start processing. |
| | |
| | The information in this field could be useful in |
| | tuning the ready-to-run option on the SMPTASK |
| | Multi-User startup option. |
+------------------+--------------------------------------------------+
| IOCount | The number of I/Os this TCB or SRB performed. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCTRACE

DCTRACE Command

The DCTRACE command displays the user request trace table.

Command Syntax

+------------------+--------------------------------------------------+
| DCTRACE | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Command | The command generating the trace entry. |
+------------------+--------------------------------------------------+
| TaskNum | The task number. |
+------------------+--------------------------------------------------+
| DBID | The database ID. |
+------------------+--------------------------------------------------+
| Table | The table ID. |
+------------------+--------------------------------------------------+
| SeqNum | The request sequence number. |
+------------------+--------------------------------------------------+
| RC | The return code. |
+------------------+--------------------------------------------------+
| IE | The internal error code in hexadecimal format. |
+------------------+--------------------------------------------------+
| BBBBL | The record ID in hexadecimal format. |
+------------------+--------------------------------------------------+
| S2 | The type of buffer (internal use only). |
+------------------+--------------------------------------------------+
| WLen | The work area length returned for the request. |
+------------------+--------------------------------------------------+
| WorkAddr | The work area address. |
+------------------+--------------------------------------------------+
| RequAddr | The request area address. |
+------------------+--------------------------------------------------+
| KeyID | The key ID. |
+------------------+--------------------------------------------------+
| URTNum | The URT number. |
+------------------+--------------------------------------------------+
| EXCPs | The number of I/Os for the request. |
+------------------+--------------------------------------------------+
| UniqueID | The unique trace ID. |
+------------------+--------------------------------------------------+
| Clock | The time value for the entry. Digits correspond |
| | to the middle four bytes of the doubleword STCK |
| | value. |
+------------------+--------------------------------------------------+
| IndexFields | The index fields of the request area. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCTRACEB

DCTRACEB Command

The DCTRACEB command displays the buffer management trace table.

Command Syntax

+------------------+--------------------------------------------------+
| DCTRACEB | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Command | The command generating the trace entry. |
+------------------+--------------------------------------------------+
| TaskNum | The task number. |
+------------------+--------------------------------------------------+
| DBID | The database ID. |
+------------------+--------------------------------------------------+
| Table | The Table ID or Area ID. |
+------------------+--------------------------------------------------+
| S1 | The type of request (internal use only). |
+------------------+--------------------------------------------------+
| S2 | The type of buffer (internal use only). |
+------------------+--------------------------------------------------+
| S3 | The other type of request or buffer (internal |
| | use only). |
+------------------+--------------------------------------------------+
| S4 | The type of wait (internal use only). |
+------------------+--------------------------------------------------+
| S5 | The other type of wait (internal use only). |
+------------------+--------------------------------------------------+
| BBBBL | The record ID in hexadecimal format. |
+------------------+--------------------------------------------------+
| URI | A Unique Row Identifier. |
+------------------+--------------------------------------------------+
| DXX/Data | The DXX or Data buffer directory entry address. |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCVOLUME

DCVOLUME Command

The DCVOLUME command displays volume information for each directory.

Command Syntax

+------------------+--------------------------------------------------+
| DCVOLUME | [ dbid ] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| dbid | The database ID to be displayed. If no DBID is |
| | specified, then all database IDs are displayed. |
| | |
| | If "*", "=", or "ALL" is entered as the DBID, |
| | then all database IDs are displayed. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| DBID | The request database ID. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DBID | The database ID where the area is contained. |
+------------------+--------------------------------------------------+
| Area | This field contains CXX for the directory row, |
| | IXX for each index area row, or the data area |
| | name for each data area row. |
+------------------+--------------------------------------------------+
| Seq# | Within one area, this field contains the |
| | sequence number of this volume serial. The |
| | volume containing the first extent (or set of |
| | extents) has a sequence number of 1, the volume, |
| | if any, containing the next extent (or set of |
| | extents) has a sequence number of 2 and so on. |
+------------------+--------------------------------------------------+
| Volser | The volume serial number that contains one or |
| | more extents of this area. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+------------------+--------------------------------------------------+
| Command | Description |
+------------------+--------------------------------------------------+
| VToc | Invokes the VTOC command for the selected |
| | volume. |
+------------------+--------------------------------------------------+
| XTents | Invokes the EXTENTS command for the selected |
| | volume. |
+------------------+--------------------------------------------------+

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCXCF

DCXCF Command

The DCXCF command displays information contained in the startup


option XCFFROM statement. The table remains empty if the XCFMVS
coupling facility is not being used.

Command Syntax

+------------------+--------------------------------------------------+
| DCXCF | |
+------------------+--------------------------------------------------+

Parameters

This command has no parameters.

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| MUFname | The name of the Multi-User-Facility specified in |
| | the Multi-User-Facility startup option MUF or |
| | the name of the Multi-User-Facility jobname. |
+------------------+--------------------------------------------------+
| Group | The name of the group containing the MUF |
| | identified in MUF_NAME from which this |
| | Multi-User-Facility can accept requests. |
+------------------+--------------------------------------------------+
| Jobs | The number of active jobs that are connected |
| | from a MUF or to a MUF. |
+------------------+--------------------------------------------------+
| JobsTot | The number of jobs that were shipped or |
| | received. |
+------------------+--------------------------------------------------+
| Requests | The number of active requests that are connected |
| | from a MUF or to a MUF facility. |
+------------------+--------------------------------------------------+
| ReqsTot | The number of requests that were shipped or |
| | received. |
+------------------+--------------------------------------------------+
| SysName | The system from which this MUF can accept |
| | requests, as specified with the XCF_FROM option. |
+------------------+--------------------------------------------------+
| Jobname | The job name from which this MUF can accept |
| | requests, as specified with the XCF_FROM option. |
+------------------+--------------------------------------------------+
| Status | CURRENT_STATUS as specified with the XCF_FROM |
| | option. Valid values are: |
| | |
| | DELETE |
| | NO |
| | YES |
+------------------+--------------------------------------------------+

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DCZIIP

DCZIIP Command

The DCZIIP command displays SRB/zIIP statistics when SRB mode is


specified with the SMPTASK Multi-User startup option.

XSystem Command

This command is capable of displaying data from multiple systems.


Follow this link for more information: XSystem Data Overview

Command Syntax

+------------------+--------------------------------------------------+
| DCZIIP | [ REGion | SYStem ] |
| | |
| | [ GROUP name ] |
| | [ XSGroup name ] |
| | |
| | [ XSYStem | NOXSYStem ] |
| | [ XSData | NOXSData ] |
+------------------+--------------------------------------------------+
Parameters

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| REGion | Display only the current target address space. |
| | This forces cross system data collection to be |
| | set off for this execution. |
| | |
| | This value can be also be set by issuing the |
| | SET DCMODE REGION command. |
| | |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| SYStem | Display data for all monitored Datacom address |
| | spaces on the current system. |
| | |
| | This value can also be set by issuing the |
| | SET DCMODE SYSTEM command. |
| | |
| | The current XSDATA profile setting for the |
| | command is honored. |
+------------------+--------------------------------------------------+
| GROUP | Specifies that an argument is to follow that |
| | indicates the group name containing the list of |
| | Datacoms to be displayed. The list of available |
| | groups with type JOBNAME can be found on the |
| | GROUPS display. A group name of "*" or "NONE" |
| | can be entered to indicate that no group |
| | processing is required. If profile variable |
| | DCGROUP has a value, it will be used unless it |
| | is explicitly overridden in the command string. |
+------------------+--------------------------------------------------+
| XSYStem | Display data for all Datacom address spaces for |
| XSData | all systems. This forces cross system data |
| | collection to be set on for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| NOXSYStem | This forces cross system data collection to be |
| NOXSData | set off for this execution. |
| | The current profile setting of XSDATA is |
| | maintained. |
+------------------+--------------------------------------------------+
| XSGroup | Specifies a value that determines the remote |
| | systems to be displayed. |
| | |
| | If this parameter is not specified then the |
| | XSGROUP profile setting is used. |
| | |
| | Valid values are: |
| | |
| | group - A logical group name of type XSSYSTEM |
| | that contains a list of systems. The |
| | group member names are the names of |
| | the systems from which data will be |
| | displayed. Aliases defined in the |
| | SYSNAMES parmlib member cannot be |
| | used as group member names. |
| | |
| | The list of XSSYSTEM groups can be |
| | found on the GROUPS command. |
| | |
| | system - A specific system name. An alias name |
| | defined in the SYSNAMES parmlib |
| | member can also be used. |
| | |
| | ALL - All connected systems are displayed. |
| | * |
| | |
| | NONE - Only display data from the local |
| | system. This is similar to using the |
| | SYSTEM parameter except the XSSystem, |
| | XSJobnam and XSMsg fields are also |
| | displayed. |
| | |
| | If XSGROUP is specified, cross-system data |
| | collection will be automatically turned on for |
| | this execution. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Jobname | The jobname of the current address space. |
+------------------+--------------------------------------------------+
| ASID | The address space ID. |
+------------------+--------------------------------------------------+
| Jobid | The job identifier. |
+------------------+--------------------------------------------------+
| Datacom | The Datacom release if the current jobname |
| | is being monitored. |
+------------------+--------------------------------------------------+
| Mode | The current mode. |
| | |
| | Possible values are: |
| | |
| | REGION - A single Datacom region |
| | |
| | SYSTEM - All Datacom regions on the current |
| | system |
| | |
| | XSYSTEM - All Datacom regions on all systems |
+------------------+--------------------------------------------------+
| XSGroup | The current cross-system group name specified by |
| | by the XSGROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+
| Group | The current group name of type JOBNAME specified |
| | by the GROUP parameter or "none" as a |
| | placeholder. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Jobname | Job name of the Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| MUFName | Name of the Multi-User Facility (MUF). |
+------------------+--------------------------------------------------+
| TaskNum | A sequence number which uniquely identifies the |
| | SMP. |
+------------------+--------------------------------------------------+
| ZIIPTime | The actual total CPU time in seconds this SMP |
| | subtask ran on a zIIP processor. |
+------------------+--------------------------------------------------+
| CPCPU | If the ZIIP Multi-User startup option was |
| | specified for this SMP subtask, this is the |
| | total CPU seconds spent on a standard (non-zIIP) |
| | processor. |
+------------------+--------------------------------------------------+
| ZIIPQual | The total time in seconds for which this SMP |
| | subtask was qualified to run on a zIIP processor.|
+------------------+--------------------------------------------------+
| EnclaveCPU | Datacom SMP SRBs run in an Enclave. This is the |
| | total CPU time (in seconds) that this SMP task |
| | has used for the life of this MUF. |
+------------------+--------------------------------------------------+
| ZIIP% | The percentage of work for this subtask which is |
| | zIIP eligible. |
+------------------+--------------------------------------------------+

XSystem Data Fields

In xsystem data mode, additional data fields are present.


Follow this link to display xsystem data fields information.

Line Commands

No line commands are defined by the &HelpMember command, however


other types of line commands are available. Follow the link below
for more information.

Special Line Commands

Subcommands

+------------------+--------------------------------------------------+
| Subcommand | Function |
+------------------+--------------------------------------------------+
| REFRESH | Refresh display data. |
+------------------+--------------------------------------------------+

Notes

This command performs an automatic address space switch to the


jobname specified by the SET DCTGTDEF option. If the current
target address space is a Datacom address space then no auto
switch is performed.
DDLIST

DDLIST Command

The DDLIST command displays the libraries allocated to


a specified ddname in a specified address space.

For information about other related library listing commands see:


Library Listing Command Summary

Command Syntax

+---------------+------------------------------------------------------------+
| DDLIST | ddname[,asid] |
+---------------+------------------------------------------------------------+

Parameters

+----------------+-----------------------------------------------------------+
| Parameter | Explanation |
+----------------+-----------------------------------------------------------+
| ddname | The name of the data definition for which to search. |
+----------------+-----------------------------------------------------------+
| asid | The ASID of the target address space. For details on |
| | specifying an ASID parameter, see the ASID command. If |
| | the ASID parameter is omitted, then the current ASID is |
| | used. |
+----------------+-----------------------------------------------------------+

Information Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Options | This field lists the following option keywords: |
| | |
| | ALL |
| | DUPLICAT |
| | UNIQUE |
| | |
| | These fields are cursor selectable. Positioning the cursor |
| | over one of the above keywords and hitting the ENTER key |
| | will invoke the subcommand of the same name. |
| | |
| | If SET TABINFOOPTS YES is in effect then you can use the |
| | NEWLINE or TAB keys to position the cursor to the keyword. |
| | |
| | Click here to see your TABINFOOPTS setting. |
| | Click here to set your TABINFOOPTS setting to YES. |
| | Click here to set your TABINFOOPTS setting to NO. |
| | Click here to view help for the SET TABINFOOPTS option. |
| | |
+---------------+------------------------------------------------------------+
| Jobname | The jobname of the current address space. |
+---------------+------------------------------------------------------------+
| ASID | The address space ID. |
+---------------+------------------------------------------------------------+
| Jobid | The job identifier. |
+---------------+------------------------------------------------------------+
| DDname | The ddname of the libraries displayed. |
+---------------+------------------------------------------------------------+
| Libraries | The total number of DDLIST libraries. |
+---------------+------------------------------------------------------------+
| Alloc | The number of libraries successfully allocated. |
+---------------+------------------------------------------------------------+
| Open | The number of libraries successfully opened. |
+---------------+------------------------------------------------------------+
| The following fields are displayed only after a WHERE subcommand: |
+---------------+------------------------------------------------------------+
| Search | The number of libraries searched by the WHERE subcommand. |
+---------------+------------------------------------------------------------+
| Found | The number of matches found by the WHERE subcommand. |
+---------------+------------------------------------------------------------+
| Member | The member name searched for by the WHERE subcommand. |
+---------------+------------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Dataset-Name | The data set name. |
+---------------+------------------------------------------------------------+
| Volser | The volume serial number where the data set is located. |
+---------------+------------------------------------------------------------+
| APF | The APF data set, if APF-authorized. Otherwise, it is |
| | blank. This field is only present for data sets that are |
| | in load library format. |
+---------------+------------------------------------------------------------+
| Message | Message information generated while accessing the data |
| | set. |
+---------------+------------------------------------------------------------+
| The following fields are displayed only after a WHERE subcommand |
| had executed. |
+---------------+------------------------------------------------------------+
| Found | When the member name is masked, this field displays |
| | the number of matches found by the WHERE subcommand. |
+---------------+------------------------------------------------------------+
| Size | When the format is displaying a load library this is the |
| | size of the module. For an ISPF format, this is the |
| | current record size of the member. |
+---------------+------------------------------------------------------------+
| Fields specific to the load library format |
+---------------+------------------------------------------------------------+
| Linkdate | The date member was link-edited. |
+---------------+------------------------------------------------------------+
| AC | The authorization code. |
+---------------+------------------------------------------------------------+
| RM | The residency mode. |
+---------------+------------------------------------------------------------+
| AM | The addressing mode. |
+---------------+------------------------------------------------------------+
| Attributes | The member attributes. Valid values are: |
| | |
| | FO F-level linkage editor |
| | RF Refreshable |
| | RN Reentrant |
| | RU Reusable |
| | NX Not executable |
| | OL Only loadable |
| | NE Not editable |
| | SC Scatter load format |
| | OV Overlay format |
| | TS Linked with TEST |
| | |
+---------------+------------------------------------------------------------+
| Fields specific to the ISPF format. |
+---------------+------------------------------------------------------------+
| VV.MM | The version and modification level. |
+---------------+------------------------------------------------------------+
| Created | The date the member was created. |
+---------------+------------------------------------------------------------+
| UpdDate | The date the member was last updated. |
+---------------+------------------------------------------------------------+
| UpdTm | The time the member was last updated. |
+---------------+------------------------------------------------------------+
| User-ID | The user ID of the last modifier. |
+---------------+------------------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Action Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| REFresh | Invokes the LLAREFR command for the data set. |
+---------------+------------------------------------------------------------+
| Zap | Invokes the ZAP command for the data set. |
+---------------+------------------------------------------------------------+
| ZRO | Invokes the ZAP command with the READONLY option. |
+---------------+------------------------------------------------------------+
| ZRW | Invokes the ZAP command with the READWRITE option. |
+---------------+------------------------------------------------------------+

Navigation Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Browse | Invokes the BROWSE command for the data set. This is |
| | valid only when ISPF services are available. If a |
| | previous WHERE subcommand found a match in the selected |
| | data set, then the BROWSE command invoked includes the |
| | searched-for member name. |
+---------------+------------------------------------------------------------+
| DSinfo | Invokes the DSINFO command for the data set. |
| Info | |
+---------------+------------------------------------------------------------+
| Edit | Invokes the EDIT command for the data set. This is valid |
| | only when ISPF services are available. If a previous |
| | WHERE subcommand found a match in the selected data set, |
| | then the EDIT command invoked includes the searched-for |
| | member name. |
+---------------+------------------------------------------------------------+
| ENQueue | Invokes the ENQUEUE command specifying SYSDSN as the qname |
| NQ | and the selected data set name as the rname. |
+---------------+------------------------------------------------------------+
| Listdir | Invokes the LISTDIR command for the data set. If a |
| Ldir | previous WHERE subcommand found a match in the selected |
| | data set, then the LISTDIR command invoked includes the |
| | searched-for member name. |
+---------------+------------------------------------------------------------+
| LMid | Invokes the LISTDIR command for the selected data set |
| | with the MODID keyword to display standard module |
| | identification information for all members in the data |
| | set. |
+---------------+------------------------------------------------------------+
| View | Invokes the VIEW command for the data set. This is valid |
| | only when ISPF services are available. If a previous |
| | WHERE subcommand found a match in the selected data set, |
| | then the VIEW command invoked includes the searched-for |
| | member name. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| ALL | Invokes the LISTMDIR command with the ALL option to |
| | display all members in all libraries. |
+---------------+------------------------------------------------------------+
| CLEAR | Clears the results of a previous WHERE subcommand. |
+---------------+------------------------------------------------------------+
| DUPLICAT | Invokes the LISTMDIR command with the DUPLICAT option |
| | to display duplicate members in all libraries. Duplicate |
| | members are members that exist in more than one library. |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh the display data. |
+---------------+------------------------------------------------------------+
| UNIQUE | Invokes the LISTMDIR command with the UNIQUE option |
| | to display unique members in all libraries. Unique |
| | members are member that exist in only one library. |
+---------------+------------------------------------------------------------+
| WHERE | Searches all libraries for a specific or generic module |
| | name. |
+---------------+------------------------------------------------------------+

WHERE Subcommand

Use the WHERE subcommand to search all libraries allocated to


a ddname for a specific or generic member and display summary
information about each member found.

WHERE Subcommand Format

+---------------+------------------------------------------------------------+
| WHERE | name |
+---------------+------------------------------------------------------------+

WHERE Subcommand Parameters Explained


+---------------+------------------------------------------------------------+
| Parameter | Explanation |
+---------------+------------------------------------------------------------+
| name | The name of the member to search for. Masking characters |
| | can be used to search for a generic member name. Your |
| | mask characters are: |
| | |
| | = Variable length mask character |
| | * Fixed length mask character |
| | |
+---------------+------------------------------------------------------------+

CLEAR Subcommand

Use the CLEAR subcommand to clear the results displayed by a previous WHERE
subcommand. The CLEAR command has no parameters.

Related Information

Library concatenation - USER, SITE and SYSTEM

Messages

DDLS001I [memname] not found

Either the DD name is not allocated to the specified address


space, or the member [memname] is not found in any libraries
searched.

DDLS002E No libraries available to search

The WHERE subcommand can find no libraries that are currently


available to search.

DDLS003E DDname [ddname] not allocated to a PDS

DDLIST has found that the DD name [ddname] is not allocated to a


partitioned dataset.

DDLS004E DDname [ddname] not allocated

DDLIST has found that the DD name [ddname] is not allocated.


DELAYS

DELAYS Command

The DELAYS command displays the status of delayed jobs. This


information is obtained from RMF and is based on the last interval
of data gathered by RMF. The data will change only when RMF updates
the information for a new interval.

Both RMF and the RMF Monitor III data gatherer RMFGAT are required
to be active to obtain this data.

To see summarized and detailed delayed jobs information for multiple


RMF intervals, see the RMJSTAT command.

Command Syntax

+---------------+------------------------------------------------------------+
| DELAYs | |
+---------------+------------------------------------------------------------+

Information Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Samples | Displays the number of samples taken during the interval. |
+---------------+------------------------------------------------------------+
| Interval | Displays the number of seconds during which the samples |
| | were taken. |
+---------------+------------------------------------------------------------+
| Time | Displays the time when the last interval started. |
+---------------+------------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Jobname | Specifies the name of the job. |
+---------------+------------------------------------------------------------+
| Reason | Reason for the delay. Possible values are: |
| | |
| | CPU - CPU time was not available. |
| | DEVICE - A device or devices were not available. |
| | STORAGE - Storage was not available. |
| | JES - JES resources were not available. |
| | HSM - HSM resources were not available. |
| | XCF - XCF resources were not available. |
| | MOUNT - A device was waiting to be mounted. |
| | MESSAGE - An operator reply was pending. |
| | ENQUEUE - An enqueue conflict existed. |
| | |
| | If the job is delayed for more than one reason, the |
| | reason contributing the highest percentage of overall |
| | delay is shown. |
+---------------+------------------------------------------------------------+
| CPU | Specifies the percent of time the job was waiting for |
| | CPU resources during the interval. |
+---------------+------------------------------------------------------------+
| Dev | Specifies the percent of time the job was waiting for |
| | a device during the interval. |
+---------------+------------------------------------------------------------+
| Stg | Specifies the percent of time the job was waiting for |
| | storage during the interval. |
+---------------+------------------------------------------------------------+
| Sub | Specifies the percent of time the job was waiting for |
| | a subsystem request during the interval. |
+---------------+------------------------------------------------------------+
| Opr | Specifies the percent of time the job was waiting for |
| | an operator response during the interval. |
+---------------+------------------------------------------------------------+
| Enq | Specifies the percent of time the job was waiting for |
| | access to an enqueue during the interval. |
+---------------+------------------------------------------------------------+
| Pct% | Specifies the percent of time the job was waiting for |
| | resources during the interval. This field is a status |
| | field and will be set to warn if the percent is 50 |
| | percent or greater but less than 75 percent. It will |
| | be set to problem if the percent is 75 percent or |
| | more. The values for the warn and problem status |
| | modes are not modifiable. |
+---------------+------------------------------------------------------------+
| Pct-Delay | Graph of the percent of time the job was waiting for |
| | resources during the interval. |
+---------------+------------------------------------------------------------+
| Detail | Additional information for the delay (Reason) if more |
| | information is available. |
| | |
| | CPU - The top 5 users of the CPU resource being |
| | waited on. It is possible for a multi-TCB |
| | ASID to be waiting on itself. |
| | DEVICE - The top 6 devices the job was waiting on. |
| | STORAGE - Storage was not available. |
| | JES - Reason for JES delay. |
| | HSM - Reason for HSM delay. |
| | XCF - Path(s) contributing most to the delay due to|
| | XCF signalling traffic (up to 4 are shown). |
| | MOUNT - VOLSER waiting to be mounted. |
| | MESSAGE - The operator reply number. |
| | ENQUEUE - QNAME:RNAME of the enqueue. |
+---------------+------------------------------------------------------------+
| Samples | Specifies the number of samples taken during the interval |
| | for the job. |
+---------------+------------------------------------------------------------+
| Srvclass | Specifies the service class name when the system is |
| | running in goal mode. |
+---------------+------------------------------------------------------------+
| ASID | Specifies the hexadecimal address space ID. |
+---------------+------------------------------------------------------------+
| Jobnr | Specifies the job number. Some system tasks do not have |
| | job numbers. |
+---------------+------------------------------------------------------------+
| Stepname | Specifies the current stepname. Stepnames are displayed |
| | only for jobs that have a stepname coded in the JCL. |
+---------------+------------------------------------------------------------+
| Procstep | Specifies the current procedure stepname. Procedure |
| | stepnames are displayed only for jobs that use a PROC |
| | statement in the JCL. For TSO jobs, the terminal name is |
| | displayed in the Procstep field. |
+---------------+------------------------------------------------------------+
| Type | Specifies the type of job. Valid values are: |
| | |
| | JOB A batch job |
| | SYS A system task |
| | STC A started task |
| | TSU A TSO user |
| | INIT An initiator |
| | ATX An APPC transaction |
| | OTX An OpenMVS transaction |
+---------------+------------------------------------------------------------+
| Status | Specifies the status of the job. Valid values are: |
| | |
| | NS Nonswappable |
| | LSW Logically swapped |
| | GO OUT Currently being swapped out |
| | GO IN Currently being swapped in |
| | IN Swapped in |
| | OUT TO Swapped out--terminal output wait |
| | OUT TI Swapped out--terminal input wait |
| | OUT LW Swapped out--long wait |
| | OUT XS Swapped out--auxiliary storage shortage |
| | OUT RS Swapped out--real storage shortage |
| | OUT DW Swapped out--detected wait |
| | OUT RQ Swapped out--requested swap |
| | OUT NQ Swapped out--enqueue exchange swap |
| | OUT EX Swapped out--exchange on recommended value |
| | OUT US Swapped out--unilateral swap |
| | OUT TS Swapped out--transition swap |
| | OUT IC Swapped out--improve central storage |
| | OUT IP Swapped out--improve system paging |
| | OUT MR Swapped out--make room |
| | OUT AW Swapped out--APPC wait |
| | OUT OI Swapped out--OMVS input wait |
| | OUT OO Swapped out--OMVS output wait |
| | OUT SR Swapped out--real swap |
+---------------+------------------------------------------------------------+
| CPU-Time | Specifies the accumulated CPU time (in CPU seconds) used |
| | by the job. This includes the accounted task time and the |
| | job step time. |
+---------------+------------------------------------------------------------+
| R-Stg | Specifies the amount of real storage the job is using in |
| | the private region. |
+---------------+------------------------------------------------------------+
| CSA | Specifies the amount of CSA storage used by the job. This |
| | is valid only if the Virtual Storage Manager (VSM) |
| | tracking facility is active. |
+---------------+------------------------------------------------------------+
| E-CSA | Specifies the amount of extended CSA storage used by the |
| | job. This is valid only if the Virtual Storage Manager |
| | (VSM) tracking facility is active. |
+---------------+------------------------------------------------------------+
| SQA | Specifies the amount of SQA storage used by the job. This |
| | is valid only if the Virtual Storage Manager (VSM) |
| | tracking facility is active. |
+---------------+------------------------------------------------------------+
| E-SQA | Specifies the amount of extended SQA storage used by the |
| | job. This is valid only if the Virtual Storage Manager |
| | (VSM) tracking facility is active. |
+---------------+------------------------------------------------------------+
| C-Stg | Specifies the total amount of common storage used by the |
| | job. This is valid only if the Virtual Storage Manager |
| | (VSM) tracking facility is active. |
+---------------+------------------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+---------------+------------------------------------------------------------+
| Command | Description |
+---------------+------------------------------------------------------------+
| Menu | Invokes the MENU ADDRSPC command. |
+---------------+------------------------------------------------------------+
| Select | Depending on the reason for the delay, invokes another |
| | command to display more information if more information |
| | is available. Note that the displayed job may no longer |
| | be delayed so no additional information may be available |
| | as to why it was delayed. |
+---------------+------------------------------------------------------------+

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| REFRESH | Refresh display data. The data will change only when RMF |
| | updates the information for a new interval. |
+---------------+------------------------------------------------------------+

Messages

DLYS001W RMF required for the DELAYS command

RMF is required for the information displayed by the DELAYS command.

DLYS002W Load for ERB3XDRS failed

The dataset that contains the RMF ERB3XDRS module must be


accessible to the SYSVIEW session.

DLYS003I No more information available

An attempt was made to drill down for more information.


Additional information is not available.

DLYS004I [delayreason]

The current delay reason is displayed.


DELMAPS

DELMAPS Command

The DELMAPS command deletes loaded DSECT maps.

Follow the Symbol and Map Command Summary hyperlink


for additional information.

Command Syntax

+---------------+------------------------------------------------------------+
| DELMAPS | mapname | ALL [membername] |
+---------------+------------------------------------------------------------+

Parameters

+----------------------+-----------------------------------------------------+
| Parameter | Explanation |
+----------------------+-----------------------------------------------------+
| mapname | Deletes a specific map. |
+----------------------+-----------------------------------------------------+
| ALL | Deletes all loaded maps. |
+----------------------+-----------------------------------------------------+
| ALL membername | Deletes all maps in a specified member. |
+----------------------+-----------------------------------------------------+

Messages

DELM001I Map deleted - [mapnm]

Informational only.

DELM002W Map not loaded - [mapnm]

Informational only.

DELM003I Maps deleted for member [mbrnm] - [count]

Informational only.

DELM004I Maps deleted for all members - [count]

Informational only.
DEST

DEST Command

The DEST command can be used to limit which jobs or devices are
displayed by limiting the display to certain destinations.

The DEST command affects the following commands:

+-----------+----------------------------------------------------------------+
| Command | Fields where destination selection occurs |
+-----------+----------------------------------------------------------------+
| JHELDQUE | Destination |
+-----------+----------------------------------------------------------------+
| JJOBQUE | Destination |
+-----------+----------------------------------------------------------------+
| JOBSUM | DestPrt |
+-----------+----------------------------------------------------------------+
| JOUTQUE | Destination |
+-----------+----------------------------------------------------------------+
| JPRINTER | Dest1, Dest2, Dest3, Dest4 |
+-----------+----------------------------------------------------------------+
| JTRANQUE | Destination |
+-----------+----------------------------------------------------------------+
| LISTINP | DestPrt |
+-----------+----------------------------------------------------------------+
| JPUNCH | Dest1, Dest2, Dest3, Dest4 |
+-----------+----------------------------------------------------------------+
| JREADER | PrtDest |
+-----------+----------------------------------------------------------------+

For the Printer or Punch Displays, if any of the four destinations


match a destination specified with the DEST command, then the device is
displayed.

Command Syntax

+---------------+------------------------------------------------------------+
| DEST | [dest][,dest][,dest][,dest] |
| | +,dest[,dest][,dest] |
| | -,dest[,dest][,dest] |
| | ? |
+---------------+------------------------------------------------------------+

Parameters

+---------------+------------------------------------------------------------+
| Parameter | Explanation |
+---------------+------------------------------------------------------------+
| dest | Specifies a 1- to 8-character destination used to limit |
| | the display. A maximum of four destinations can be |
| | specified. |
+---------------+------------------------------------------------------------+
| + | Specifies that the remaining dest parameters should be |
| | added to the current list. A maximum of three |
| | destinations can be added. |
+---------------+------------------------------------------------------------+
| - | Specifies that the remaining dest parameters should be |
| | deleted from the current list. A maximum of three |
| | destinations can be deleted. |
+---------------+------------------------------------------------------------+
| ? | Displays the destinations in the list. The destinations |
| | are displayed on the message line. |
+---------------+------------------------------------------------------------+

Notes
* If the DEST command is entered with no parameters, then all destinations
are deleted. If the DEST command is entered without the + or - parameter,
then the new dest parameters replace the old destination list.

Messages

DEST001E A destination must be specified when adding or deleting

The add (+) or delete (-) parameter was used with the DEST
command, but a destination to add or delete was not specified.
Specify one to three destinations to add or delete.

DEST002I Destinations are [dest] [dest] [dest] [dest]

This message displays the current destination names in the


destination names table.

DEST003E Destination [dest] cannot be added - maximum limit exceeded

An attempt was made to add a destination to the destination


names table, but the table was already full. Delete a
destination before attempting to add another destination.

DEST004W Destination [dest] is already in the table

An attempt was made to add a destination to the destination


names table, but the name was already in the table.

DEST005E Destination [dest] is not in the table

An attempt was made to delete a destination from the


destination names table, but the name was not in the table.

DEST006I There are no destinations in the table

Self-explanatory.

DEST007I All destinations cleared

This message is displayed when the DEST command is entered


with no parameters. This clears the destination names table.
DETAILS

DETAILS Command

The DETAILS command is a common or generic command driver used to


display drill-down or detail information from another command
source.

Command Syntax

+------------------+--------------------------------------------------+
| DETAILS | [options] subcommand [parameters] |
+------------------+--------------------------------------------------+

Parameters

Options

Options that apply to the DETAILS command must be specified prior


to the requested subcommand keyword. Each subcommand may support
additional options that are specific to the subcommand and will
entered as part of the subcommand's parameters.

+------------------+--------------------------------------------------+
| Parameter | Explanation |
+------------------+--------------------------------------------------+
| HELP member | Specify the name of the help member that is to |
| | be displayed and associated with the detail |
| | display. |
+------------------+--------------------------------------------------+
| PARMS | Display the parameters specified for the |
| | subcommand in the information section. |
+------------------+--------------------------------------------------+
| NOPARMS | Do not display the paramters specified for the |
| | subcommand in the information section. |
+------------------+--------------------------------------------------+
| INFO | Display the information lines generated by |
| | the subcommand in the information section. |
+------------------+--------------------------------------------------+
| NOINFO | Do not display the information lines generated |
| | by the subcommand in the information section. |
+------------------+--------------------------------------------------+

Subcommand and Parameters

+------------------+--------------------------------------------------+
| Subcommand | Explanation |
+------------------+--------------------------------------------------+
| CICSTASK | Display a detail report for an active CICS |
| | transaction. |
| | |
| | Parameters: |
| | |
| | jobname tasknum [options] |
| | |
| | jobname - Specify the CICS jobname for the |
| | active task. |
| | |
| | tasknum - Specify task number of the |
| | active task. |
| | |
| | options - Options |
| | |
| | DUMP - Display the SMF record |
| | associated with the |
| | requested task in |
| | dump format. |
| | |
| | NODUMP - Do not display the |
| | SMF record associated |
| | with the requested |
| | task in dump format. |
| | |
+------------------+--------------------------------------------------+
| DBTHACT | Display a detail report for the specified |
| | DB2 thread. |
| | |
| | Parameters: |
| | |
| | ssid jobname ace [options] |
| | |
| | ssid - DB2 subsystem ID |
| | jobname - jobname |
| | ace - ACE token |
| | |
| | options - Options |
| | |
| | BIZ - Blank If Zero |
| | When displaying graph |
| | data, do not include |
| | rows with a zero value. |
| | |
| | NOBIZ - No Blank If Zero |
| | When displaying graph |
| | data, display all rows |
| | regardless of value. |
| | |
+------------------+--------------------------------------------------+
| FXE | Display a detail report for the IBM Function |
| | Registry for z/OS. |
| | |
| | Parameters: |
| | |
| | [ VS vsslot [ PS psslot [PRODINSTANCE pi ]]] |
| | [options] |
| | |
| | vsslot - Specify the vendor slot number |
| | to be displayed. |
| | |
| | * - Display all vendors. |
| | |
| | psslot - Specify the product slot number |
| | to be displayed. |
| | |
| | * - Display all products. |
| | |
| | pi - Specify the product instance to |
| | be displayed. |
| | |
| | * - Display all product |
| | instances. |
| | |
| | options Description |
| | ------------ ------------------------------- |
| | TOC Display table of contents. |
| | NOTOC Do not display table of contents.|
| | |
| | PATH Display path bread crumbs. |
| | NOPATH Do not display path bread crumbs.|
| | |
| | Optional parameters that control the amount |
| | of detail sections displayed. |
| | |
| | options Description |
| | ------------ ------------------------------- |
| | PRODUCTS Display product information. |
| | NOPRODUCTS Do not display product |
| | information. |
| | |
| | FUNCTIONS Display function information. |
| | NOFUNCTIONS Do not display function |
| | information. |
| | |
| | PRIVATEDATA Display private data |
| | information. |
| | NOPRIVATE Do not display private data |
| | information. |
| | |
| | USERDATA Display user data information. |
| | NOUSERDATA Do not display user data |
| | information. |
| | |
| | ATTRIBUTES Display attribute information. |
| | NOATTRIBUTES Do not display attribute |
| | information. |
| | |
| | AUDIT Display audit information. |
| | NOAUDIT Do not display audit |
| | information. |
| | |
| | FULL Display all available sections. |
| | BASIC Display a limited or basic set |
| | of sections that include: |
| | |
| | Vendors |
| | Vendor - vendor.n |
| | Vendor Products |
| | Product - product.n |
| | Product Functions |
| | |
| | This is equivalent to |
| | specifying the following |
| | options: |
| | |
| | PRODUCTS |
| | NOFUNCTIONS |
| | NOPRIVATE |
| | NOUSERDATA |
| | NOATTRIBUTES |
| | NOAUDIT |
| | |
+------------------+--------------------------------------------------+
| HWILIST | Hardware Management Console (HMC) and BCPii |
| | configuration information. |
| | |
| | Parameters: |
| | |
| | type [objects] [options] |
| | |
| | type - list type |
| | objects - objects specific to type |
| | |
| | Valid "list" types: |
| | |
| | CAPRecs - List of capacity record ID names|
| | |
| | CPCs - List of CPCs |
| | |
| | EVENTs - List of subscribed events |
| | |
| | GROUPs - List of defined user image |
| | groups |
| | |
| | IMAGEAProf - List of defined image activation|
| | profiles |
| | |
| | IMAGESCpc - List of image names on the CPC |
| | |
| | IMAGESGroup - List of image names defined in |
| | a user defined image group |
| | |
| | LOADAProf - List of defined load activation |
| | profiles |
| | |
| | LOCALCpc - Name of the local CPC |
| | |
| | LOCALImage - Name of the local image (LPAR) |
| | |
| | RESETAProf - List of defined reset activation|
| | profiles |
| | |
| | |
| | type objects |
| | ------------ ------------------------------- |
| | CAPRECS cpc |
| | CPCS |
| | EVENTS cpc |
| | GROUPS cpc |
| | IMAGEAPROF cpc |
| | IMAGESCPC cpc |
| | IMAGESGROUP cpc group |
| | LOADAPROF cpc |
| | LOCALCPC |
| | LOCALIMAGE |
| | RESETAPROF cpc |
| | |
| | Valid values for "cpc": |
| | |
| | * - local host CPC |
| | netid.nau - 17 character network address |
| | netid - network ID |
| | nau - network addressable |
| | unit |
| | |
| | options Description |
| | ------------ ------------------------------- |
| | TOC - Display table of contents |
| | |
| | NOTOC - Do not display table of contents|
| | |
| | DIAG - Display diagnostic information |
| | |
| | NODIAG - Do not display diagnostic |
| | information |
| | |
+------------------+--------------------------------------------------+
| HWIQUERY | Hardware Management Console (HMC) and BCPii |
| | configuration information. |
| | |
| | Parameters: |
| | |
| | type [objects] [options] |
| | |
| | type - list type |
| | objects - objects specific to type |
| | |
| | Valid "list" types: |
| | |
| | CAPRec - Capacity record |
| | CPC - Central Processor Complex (CPC) |
| | GROUP - User defined group of images |
| | IMAGE - Image or LPAR |
| | IMAGEAprof - Image activitation profile |
| | LOADAprof - Load activitation profile |
| | RESETaprof - Reset activation profile |
| | |
| | type objects |
| | ------------ ------------------------------- |
| | CAPREC - cpc caprec |
| | CPC - cpc |
| | GROUP - cpc group |
| | IMAGE - cpc image |
| | IMAGEAPROF - cpc profile |
| | LOADAPROF - cpc profile |
| | RESETAPROF - cpc profile |
| | |
| | Valid values for "cpc": |
| | |
| | * - local host CPC |
| | netid.nau - 17 character network address |
| | netid - network ID |
| | nau - network addressable |
| | unit |
| | |
| | options Description |
| | ------------ ------------------------------- |
| | MEMBER - The parmlib member containing |
| | BCPii HWIQUERY attribute |
| | definitions to be displayed. |
| | |
| | Default: GSVXHWI |
| | |
| | The member GSVXHWI contains |
| | a default set of definitions |
| | for each type. |
| | |
| | If the member GSVXHWI is |
| | specified directly or by |
| | default, the parmlib member |
| | SVWXHWI will also be searched |
| | for override definitions. |
| | |
| | SECTION - The 1 to 16 character |
| | section name within the |
| | parmlib member that contains |
| | the BCPii HWIQUERY attribute |
| | definitions. |
| | |
| | Default: * |
| | |
| | If "*" is used, the "type" |
| | value will be used for the |
| | section name. |
| | |
| | TOC - Display table of contents |
| | |
| | NOTOC - Do not display table of contents|
| | |
| | CACHE - Read the specified parmlib |
| | member from the library cache |
| | if present. |
| | |
| | NOCACHE - Do not read the specified |
| | parmlib member from the library |
| | cache. |
| | |
| | NOCACHE - Do not display table of contents|
| | |
| | DIAG - Display diagnostic information |
| | |
| | NODIAG - Do not display diagnostic |
| | information |
| | |
+------------------+--------------------------------------------------+
| JSON | Display a detail report for a JSON document. |
| | |
| | The JSON document will be checked for syntax |
| | errors and statistics about the JSON data types |
| | contained in the JSON will be displayed. |
| | |
| | Parameters: |
| | |
| | DSN dataset(member) [options] |
| | |
| | dataset - Specify the source data set |
| | of the JSON document. |
| | |
| | member - Specify the source member of |
| | the JSON document. |
| | |
| | options Description |
| | ------------ ------------------------------- |
| | TOC Display table of contents. |
| | NOTOC Do not display table of contents.|
| | |
| | Optional parameters that control the amount |
| | of detail sections displayed. |
| | |
| | options Description |
| | ------------ ------------------------------- |
| | TYPes Display data type statistics. |
| | NOTYPes Do not display data type |
| | statistics. |
| | |
+------------------+--------------------------------------------------+
| KEYRCERT | Display a detail report for a certificate |
| | connected to a keyring. |
| | |
| | Parameters: |
| | |
| | KEYRING keyring CERTIFICATE cert OWNER owner |
| | |
| | keyring - keyring name |
| | |
| | cert - certificate name |
| | |
| | owner - keyring owner user id |
| | |
+------------------+--------------------------------------------------+
| MQREPORT | Display a detail report for MQ information. |
| | |
| | Parameters: |
| | |
| | report [parms] [options] |
| | |
| | report - report type |
| | |
| | parms - parameters are specific to |
| | each report type |
| | |
| | options - parameters are specific to |
| | each report type |
| | |
| | Valid "report" types: |
| | |
| | SMDS - Shared Message Data Set statistics |
| | |
| | Syntax: |
| | DETAILS MQREPORT SMDS qmgr structure |
| | |
| | qmgr - queue manager |
| | |
| | structure - structure name |
| | |
| | options - Options |
| | |
| | DUMP - Display the SMF record |
| | associated with the |
| | requested data in |
| | dump format. |
| | |
| | NODUMP - Do not display the |
| | SMF record associated |
| | with the requested |
| | data in dump format. |
| | |
+------------------+--------------------------------------------------+
| XML | Display a detail report for an XML document. |
| | |
| | The data structures created by the z/OS XML |
| | System Services parser will be analyzed and |
| | displayed. |
| | |
| | Parameters: |
| | |
| | DSN dataset(member) [options] |
| | |
| | dataset - Specify the source data set |
| | of the XML document. |
| | |
| | member - Specify the source member of |
| | the XML document. |
| | |
| | options Description |
| | ------------ ------------------------------- |
| | TOC Display table of contents. |
| | NOTOC Do not display table of contents.|
| | |
| | Optional parameters that control the amount |
| | of detail sections displayed. |
| | |
| | options Description |
| | ------------ ------------------------------- |
| | RECords Display each parsed record |
| | in dump format. |
| | NORECords Do not display each record. |
| | |
| | COMments Display comment records. |
| | NOCOMments Do not display comment records. |
| | |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field name | Description |
+------------------+--------------------------------------------------+
| Parms | The specified parameters for the DETAILS command.|
+------------------+--------------------------------------------------+

Data Fields

The content of the data section is determined by the specific


detail formatting routine.
DEVPATH

DEVPATH Command

The DEVPATH command displays the status of the device path.

Command Syntax

+---------------+-----------------------------------------------------+
| DEVPATH | [type][,status][,devn][,unit][,volser][,chpid] |
+---------------+-----------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| type | The type of devices to display. |
| | Valid values are: |
| | |
| | ALL All types. This is the default. |
| | DASD Direct access storage devices |
| | TAPE Tape devices |
| | GRAPHIC Graphic devices (terminals) |
| | UR Unit record devices |
| | TP Teleprocessing devices |
| | CTC Channel-to-channel adapters |
| | |
+------------------+--------------------------------------------------+
| status | The status of the devices to display. |
| | Valid values are: |
| | |
| | All All statuses. This is the default. |
| | ALLOC Allocated devices |
| | OFFLINE Offline devices |
| | ONLINE Online, allocated devices |
| | |
+------------------+--------------------------------------------------+
| devn | The device numbers to display. |
| | Masking characters can be used. |
+------------------+--------------------------------------------------+
| unit | The units to display. |
| | Masking characters can be used. |
+------------------+--------------------------------------------------+
| volser | The volume serial numbers to display. Volume |
| | serial numbers apply only to DASD devices. |
| | Masking characters can be used. |
+------------------+--------------------------------------------------+
| chpid | The chpids to be displayed. Only those devices |
| | connected to the specified chpid are displayed. |
| | Masking characters can be used. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Type | The type of device. |
| | Possible values are: |
| | |
| | DASD Direct access storage device |
| | TAPE Tape device |
| | GRAPHIC Graphic device |
| | UR Unit record device |
| | TP Teleprocessing device |
| | CTC Channel-to-channel adapter |
| | |
+------------------+--------------------------------------------------+
| Status | The status of the device. |
| | Possible values are: |
| | |
| | OFFLINE Offline |
| | ONLINE Online |
| | ONLIN-P Online, VARY OFFLINE pending |
| | ALLOC Allocated |
| | ALLOC-P Allocated, VARY OFFLINE pending |
| | ALLOC-X Device allocated to some external |
| | system. This is only possible for |
| | autoswitchable tape devices. |
| | UNAVAIL Offline and unavailable. This is |
| | only possible for tape devices. |
| | |
+------------------+--------------------------------------------------+
| Devn | The device number. |
+------------------+--------------------------------------------------+
| Unit | The name of the unit. |
+------------------+--------------------------------------------------+
| Volser | The volume serial number. |
+------------------+--------------------------------------------------+
| ChP | The channel path identifier. |
+------------------+--------------------------------------------------+
| Vld | Specifies VLD if the IBM UCBINFO/PATHINFO |
| | service indicates that path validation has been |
| | completed. |
+------------------+--------------------------------------------------+
| Phy | Specifies PHY if the IBM UCBINFO/PATHINFO |
| | service indicates that the path is physically |
| | available. |
+------------------+--------------------------------------------------+
| Log | Specifies LOG if the IBM UCBINFO/PATHINFO |
| | service indicates that the path is logically |
| | available. |
+------------------+--------------------------------------------------+
| Off | An offline reason. |
| | Possible values are: |
| | |
| | MGR Offline due to ESCON Manager |
| | OPR Offline due to operator |
| | RCV Offline due to channel path recovery |
| | PND Pending offline |
| | |
+------------------+--------------------------------------------------+
| ChpType | The channel path type. |
| | Possible values are: |
| | |
| | BLK_MPX Block multiplexer |
| | BYT_MPX Byte multiplexer |
| | CF_PEER Coupling facility peer |
| | CF_RECV Coupling facility receiver |
| | CF_SEND Coupling facility sender |
| | CTC_SWT CTC adapter switched |
| | CTC_PTP CTC adapter point-to-point |
| | CTC_SWT CTC adapter switched point-to-point |
| | CTC_UNK Unknown CTC adapter path type |
| | DSD Direct system device |
| | EIO Emulated I/O |
| | ESC_FBR ESCON fiber extended |
| | ESC_NTV ESCON native |
| | ESC_PAC ESCON byte pacer |
| | ESC_PTP ESCON point-to-point |
| | ESC_SWT ESCON switched |
| | ESC_CNV ESCON path to a block converter |
| | FICON_BR FICON bridge |
| | FICON_IN FICON (incomplete description) |
| | FICON_NT FICON native |
| | FICON_SW FICON switched |
| | IC_PEER Internal Coupling peer |
| | ICB_PEER Integrated cluster bus peer |
| | ICB_RECV Integrated cluster bus receiver |
| | ICB_SEND Integrated cluster bus sender |
| | IISC_RCV Internal ISC receiver |
| | IISC_SND Internal ISC sender |
| | ISD Internal System Device |
| | OSA Open systems adapter |
| | OSA_DIRX OSA direct express channel path |
| | OSA_EXPR OSA express channel path |
| | OSA_CONS OSA console |
| | UNK_xx Unknown where: |
| | xx = type code |
| | UNKNOWN Unknown |
| | NOTCONN Not connected |
| | ERRxxyy Error where: |
| | xx = Return Code |
| | yy = Reason Code |
| | SCHNERR Subchannel error |
| | |
+------------------+--------------------------------------------------+
| IOType | The type of I/O operation if the device is busy. |
| | Valid values are START, HALT, or CLEAR. |
+------------------+--------------------------------------------------+
| Jobname | The name of the last job to allocate the device. |
+------------------+--------------------------------------------------+
| ASID | The ASID of the last address space to allocate |
| | the device. |
+------------------+--------------------------------------------------+
| Schn | The subchannel number. |
+------------------+--------------------------------------------------+
| Dyn | Specifies DYN for a dynamic UCB. Otherwise, it |
| | is blank. |
+------------------+--------------------------------------------------+
| UCB | The UCB address. |
+------------------+--------------------------------------------------+

Line Commands

The following table lists the line commands defined by the


&HelpMember command. Other types of line commands are also
available. Follow the link below for more information.

Special Line Commands

Navigation Line Commands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| Select | Invokes the UNIT command for the selected device. |
+---------------+-----------------------------------------------------+
| CONnect | Plot the device connect time for the selected device. |
+---------------+-----------------------------------------------------+
| DISconn | Plot the device disconnect time for the selected device. |
+---------------+-----------------------------------------------------+
| IO | Plot the SSCH instruction count for the selected device. |
| USE | |
+----------+----------------------------------------------------------+
| ON | Issues an MVS VARY PATH(devn,chpid),ONLINE command for |
| | the selected device and chpid. |
+----------+----------------------------------------------------------+
| OFf | Issues an MVS VARY PATH(devn,chpid),OFFLINE command for |
| | the selected device and chpid. |
+---------------+-----------------------------------------------------+
| PENding | Plot the device pending time for the selected device. |
+----------+----------------------------------------------------------+
| VALpath | Invokes the VALPATH command for the selected device. |
| VALidate | |
| VLD | |
+---------------+-----------------------------------------------------+
| SERvice | Plot the device service time for the selected device. |
+----------+----------------------------------------------------------+
| SUbchan | Invokes the SUBCHAN command for the selected device. |
| SChn | |
+----------+----------------------------------------------------------+
| IOCdata | Invokes the IOCDATA command for the selected device. |
+----------+----------------------------------------------------------+
| PLot | Invokes a PLOTLIST DEVICE command to display a plot |
| PLt | selection list for the selected device. |
+----------+----------------------------------------------------------+

Subcommands

+----------+----------------------------------------------------------+
| Command | Description |
+----------+----------------------------------------------------------+
| REFRESH | Refresh display data. |
+----------+----------------------------------------------------------+

Messages

DVPT003E [cmdnm] line command invalid for status [stat]

The line command entered is not valid for a device with


the indicated status.

DVPT004E [cmdnm] line command invalid for type [type]

The line command entered is not valid for the indicated type
of device.
DVPT005E [cmdnm] line command invalid, no volume mounted

The line command entered is valid only for DASD devices with
a mounted volser.

DEVSERV Command Summary


-------------------------------------------------------------------------------

DEVSERV Command

The DEVSERV performs a variety of device related functions. Follow the


hyperlinks below for detailed information for a particular function.

AVail Vary tape device available


Extract Extract device variables
Free Free a device from an ASID
Mount Mount volume to device
OFfline Vary device offline
ONline Vary device online
OPtions Set DEVSERV default options
Query Query device information
UNAVail Vary tape device unavailable
Unload Unload volume from device
Validate Validate I/O paths to a device
DISASSEM

DISASSEM Command

The DISASSEM command disassembles areas of virtual storage in address spaces


or data spaces into assembler instructions.

Command Syntax

+---------------+------------------------------------------------------------+
| DISASSEM | [address][,length][,asid] |
+---------------+------------------------------------------------------------+

Parameters

Address Parameter

If you do not enter the address parameter, the DISASSEM command uses the
current address.

Address Parameter Format

Use the following format for the address parameter:

+----------------------------------------------------------------------------+
| [prefix]base[suffix][+|-offset[suffix][+|-offset[suffix]]...] |
+----------------------------------------------------------------------------+

Address Parameter - Prefix

+----------------+-----------------------------------------------------------+
| Prefix | Explanation |
+----------------+-----------------------------------------------------------+
| @ | Specifies that the address should be treated as a 31-bit |
| | indirect address. This address is treated as the address |
| | of an address. |
+----------------+-----------------------------------------------------------+
| % | Specifies that the address should be treated as a 24-bit |
| | indirect address. This address is treated as the address |
| | of an address. |
+----------------+-----------------------------------------------------------+

Address Parameter - Base

+----------------+-----------------------------------------------------------+
| Base | Explanation |
+----------------+-----------------------------------------------------------+
| = | The start location reference. The start location is |
| | defined as the last address dumped, disassembled, or |
| | mapped. This address is displayed in the information |
| | area in the Start field. The DUMP, DISASSEM, and MAP |
| | commands set a new start address and a new current |
| | location. |
+----------------+-----------------------------------------------------------+
| * | The current location reference. The current location is |
| | defined as the address of the first byte of DUMP, |
| | DISASSEM, or MAP data currently displayed. The current |
| | location reference is valid only when DUMP, DISASSEM, or |
| | MAP data is displayed. |
+----------------+-----------------------------------------------------------+
| ¢ | The cursor location reference. The data pointed to by |
| | the cursor is processed as though you had typed it in |
| | place of the ¢ in the command input field. The data |
| | taken from the cursor location on the screen is delimited |
| | by the first nonalphanational character encountered or |
| | the end of the screen row. |
+----------------+-----------------------------------------------------------+
| hexadecimal | 1-16 hexadecimal characters. You may also include one |
| | or more hex separator characters (the underscore) in this |
| | string. How the hex separator characters are handled is |
| | controlled by the setting of the HEXSEPFORMAT option. |
| | To specify an address in the range 00000000_80000000 to |
| | 00000000_FFFFFFFF you must specify at least one leading 0 |
| | (for a total length of 9 or more hex digits). An address |
| | of 8 or less hex digits is assumed to be a 31-bit address |
| | and bit 0 (bit 32 of the corresponding 64-bit address) |
| | will be cleared to 0. |
+----------------+-----------------------------------------------------------+
| decimal | 1-20 decimal digits followed by a decimal point (period). |
+----------------+-----------------------------------------------------------+
| symbol | The address of a predefined symbol or a symbol defined |
| | with the EQUATE command. Defined symbols can be
| | displayed with the SYMBOLS command. |
+----------------+-----------------------------------------------------------+
| symbol.maplabel| The address of a map label defined in a loaded map |
| | associated with the symbol. The SYMBOLS and LISTMAPS |
| | command both display the associations between symbols and |
| | maps. |
+----------------+-----------------------------------------------------------+
| modulename | The address of a module in storage located in the |
| | nucleus, link pack area, job pack area (of the current |
| | ASID), or on the loaded module queue for any TCB in the |
| | current ASID. |
+----------------+-----------------------------------------------------------+

Address Parameter - Suffix

+----------------+-----------------------------------------------------------+
| Suffix | Explanation |
+----------------+-----------------------------------------------------------+
| ? | 31-bit indirect address. You can use multiple ? |
| | characters. |
+----------------+-----------------------------------------------------------+
| % | 24-bit indirect address. You can use multiple % |
| | characters. |
+----------------+-----------------------------------------------------------+
| ! | 64-bit indirect address. You can use multiple ! |
| | characters. |
+----------------+-----------------------------------------------------------+
| \ | 31-bit base+offset indirect address. You can use |
| | multiple \ characters. |
+----------------+-----------------------------------------------------------+

Indirect Address Character Processing

Indirect addresses specified using the indirect address


suffix characters are resolved as they are encountered
processing the address parameter from left to right. An
indirect address specified using an indirect address
prefix character is resolved last after the address
parameter has been completely processed. The base+offset
indirect address character requests that the value at
the indirect address be added to the current base value
(set with the BASE command) and the resulting value be
used as the address.

Address Parameter - Offset

+--------------------+-------------------------------------------------------+
| Offset | Explanation |
+--------------------+-------------------------------------------------------+
| hexadecimal | 1-16 hexadecimal characters. You may also include |
| | one or more hex separator characters (the underscore) |
| | in this string. How the hex separator characters are |
| | handled is controlled by the SET HEXSEPFORMAT option. |
+--------------------+-------------------------------------------------------+
| decimal | 1-20 decimal digits followed by a decimal point. |
+--------------------+-------------------------------------------------------+
| symbol | The address of a predefined symbol or a symbol |
| | defined with the EQUATE command. Defined symbols can |
| | be displayed with the SYMBOLS command. |
+--------------------+-------------------------------------------------------+
| L'symbol | The length of a symbol. |
+--------------------+-------------------------------------------------------+
| symbol.maplabel | The address of a map label defined in a loaded map |
| | associated with the symbol. The SYMBOLS and LISTMAPS |
| | commands both display the associations between |
| | symbols and maps. |
+--------------------+-------------------------------------------------------+
| L'symbol.maplabel | The length of a field named maplabel found in the map |
| | associated with the symbol. |
+--------------------+-------------------------------------------------------+
| L'mapname | The length of a map. |
+--------------------+-------------------------------------------------------+
| L'mapname.maplabel | The length of a field named maplabel found in the map |
| | named mapname. |
+--------------------+-------------------------------------------------------+
| modulename | The address of a module in storage located in |
| | nucleus, the link pack area, or the job pack area of |
| | the current ASID, or on the loaded module queue for |
| | any TCB in the current ASID. |
+--------------------+-------------------------------------------------------+
| L'modulename | The length of a module. |
+--------------------+-------------------------------------------------------+
| nnnnnnnK | The number of kilobytes. The nnnnnnn portion must be |
| | a decimal number that is multiplied by 1024. |
+--------------------+-------------------------------------------------------+
| nnnnnnnP | The number of pages. The nnnnnnn portion must be a |
| | decimal number that is multiplied by 4096. |
+--------------------+-------------------------------------------------------+
| nnnnnnnM | The number of megabytes. The nnnnnnn portion must be |
| | a decimal number that is multiplied by 1048576. |
+--------------------+-------------------------------------------------------+

Length Parameter Format

Use the following format for the length parameter:


+----------------------------------------------------------------------------+
| length[+|-length[+|-length[...]] |
+----------------------------------------------------------------------------+

Length Parameter Values

+--------------------+-------------------------------------------------------+
| Length Value | Explanation |
+--------------------+-------------------------------------------------------+
| hexadecimal | 1-16 hexadecimal characters. You may also include |
| | one or more hex separator characters (the underscore) |
| | in this string. How the hex separator characters are |
| | handled is controlled by the SET HEXSEPFORMAT option. |
+--------------------+-------------------------------------------------------+
| decimal | 1-20 decimal digits followed by a decimal point. |
+--------------------+-------------------------------------------------------+
| symbol | The address of a predefined symbol or a symbol |
| | defined with the EQUATE command. Defined symbols can |
| | be displayed with the SYMBOLS command. |
+--------------------+-------------------------------------------------------+
| L'symbol | The length of a symbol. If a command supports both |
| | the address and length parameters, and the address |
| | parameter is specified as a symbol and the length |
| | parameter is omitted, then this value is the default |
| | length. |
+--------------------+-------------------------------------------------------+
| symbol.maplabel | The address of a map label defined in a loaded map |
| | associated with the symbol. The SYMBOLS and LISTMAPS |
| | commands both display the associations between |
| | symbols and maps. |
+--------------------+-------------------------------------------------------+
| L'symbol.maplabel | The length of a field named maplabel found in the map |
| | associated with the symbol. The default length for |
| | symbol.maplabel is specified the same way the symbol |
| | default length is specified. |
+--------------------+-------------------------------------------------------+
| L'mapname | The length of a map. |
+--------------------+-------------------------------------------------------+
| L'mapname.maplabel | The length of a field named maplabel found in a map |
| | named mapname. |
+--------------------+-------------------------------------------------------+
| modulename | The address of a module in storage located in the |
| | nucleus, link pack area, or job pack area of the |
| | current ASID, or on the loaded module queue for any |
| | TCB in the current ASID. |
+--------------------+-------------------------------------------------------+
| L'modulename | The length of a module. The default length for |
| | modulename is specified the same way the symbol and |
| | symbol.maplabel default lengths are specified. |
+--------------------+-------------------------------------------------------+
| nnnnnnnK | The number of kilobytes. The nnnnnnn portion must be |
| | a decimal number that is multiplied by 1024. |
+--------------------+-------------------------------------------------------+
| nnnnnnnP | The number of pages. The nnnnnnn portion must be a |
| | decimal number that is multiplied by 4096. |
+--------------------+-------------------------------------------------------+
| nnnnnnnM | The number of megabytes. The nnnnnnn portion must be |
| | a decimal number that is multiplied by 1048576. |
+--------------------+-------------------------------------------------------+

Asid parameter
+----------------+-----------------------------------------------------------+
| Parameter | Explanation |
+----------------+-----------------------------------------------------------+
| asid | The ASID of the target address space. For details on |
| | specifying an ASID parameter, see the ASID command. If |
| | the ASID parameter is omitted, then the current ASID is |
| | used. |
+----------------+-----------------------------------------------------------+

Information Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Options | The options currently in effect. |
+---------------+------------------------------------------------------------+
| Legend | A legend explaining the special characters used in the |
| | hex portion of the display to indicate the type of error |
| | that occurred attempting to gather the data. This row is |
| | displayed only then the LEGEND option has been selected. |
+---------------+------------------------------------------------------------+
| Jobname | The name of the job. |
+---------------+------------------------------------------------------------+
| ASID | The address space ID. |
+---------------+------------------------------------------------------------+
| Jobid | The job identifier. |
+---------------+------------------------------------------------------------+
| AR | The access register mode. Valid values are ON and OFF. |
+---------------+------------------------------------------------------------+
| Dspnm | The name of the data space (if applicable). |
+---------------+------------------------------------------------------------+
| Symbol | The symbol of the start address. |
+---------------+------------------------------------------------------------+
| StrAddr | The start address (for = reference). |
+---------------+------------------------------------------------------------+
| CurAddr | The current address (for * reference). This field is |
| | displayed only when in 64-bit mode and only when the |
| | OFFSET option has been selected. |
+---------------+------------------------------------------------------------+
| CurOffs | The current offset. This field is displayed only when in |
| | 64-bit mode and only when the ADDRESS option has been |
| | selected. |
+---------------+------------------------------------------------------------+
| Spn | The subpool number of the starting address. |
+---------------+------------------------------------------------------------+
| DAT | Specifies dynamic address translation mode. Valid values |
| | are ON and OFF. |
+---------------+------------------------------------------------------------+
| Region | The region name of the start address. |
+---------------+------------------------------------------------------------+
| Module | The module name of the start address. |
+---------------+------------------------------------------------------------+
| The following information fields are displayed only if the |
| OWNER option of the OPTIONS subcommand has been selected: |
+---------------+------------------------------------------------------------+
| Owner | The jobname of the owner of the current location if the |
| | current location is in common storage and common storage |
| | tracking was active when the storage was allocated. |
+---------------+------------------------------------------------------------+
| ASID | The ASID of the owner of the current location if the |
| | current location is in common storage and common storage |
| | tracking was active when the storage was allocated. |
+---------------+------------------------------------------------------------+

Data Fields

+---------------+------------------------------------------------------------+
| Field | Description |
+---------------+------------------------------------------------------------+
| Address | The address of the first byte of data mapped on the |
| | current display line. This field is not displayed |
| | when in 64-bit mode unless the ADDRESS option has been |
| | selected. |
+---------------+------------------------------------------------------------+
| Offset | Offset from the start address to the address of the first |
| | byte of data mapped on the current display line. This |
| | field is not displayed when in 64-bit mode unless the |
| | ADDRESS option has been selected. |
+---------------+------------------------------------------------------------+
| Label | Blank. The Label field is present so that this display |
| | corresponds to the Map Display. |
+---------------+------------------------------------------------------------+
| Opcode | The operation code. |
+---------------+------------------------------------------------------------+
| Operands | Specifies formatted operands. |
+---------------+------------------------------------------------------------+
| Hex | Specifies disassembled data in hexadecimal format. If |
| | the length of the data exceeds eight bytes, it is |
| | truncated when OPTIONS NODATA is in effect; otherwise, the |
| | data is continued on subsequent lines. |
+---------------+------------------------------------------------------------+
| Char | The disassembled data in character format. Character |
| -or- | data is translated according to the setting of the XLATE |
| Ascii | subcommand of the DUMP command. Nondisplayable characters |
| | display as the nondisplay character defined in the profile.|
| | If the length of the data exceeds eight, it is truncated |
| | when OPTIONS NODATA is in effect; otherwise, the data is |
| | continued on subsequent lines. The header for this field |
| | will be "Ascii" when the XLATE option is ASCII and "Char" |
| | when it is PRODUCT or IBM. |
+---------------+------------------------------------------------------------+
| Ky | The storage protection key (decimal). |
+---------------+------------------------------------------------------------+
| P | Protection status. Valid values are: |
| | |
| | S Segment protected |
| | P Page protected |
| | L Low address protected |
| | F Fetch protected |
| | N None |
| | |
+---------------+------------------------------------------------------------+
| F | The fix status of the data. Valid values are: |
| | |
| | Y Yes, fixed |
| | N No, not fixed |
| | D Disabled reference storage |
| | |
+---------------+------------------------------------------------------------+
| Descr | Description |
+---------------+------------------------------------------------------------+
Notes

64-bit Display Mode

* If the NOAM64 option is in effect then the DISASSEM display will switch
to 64-bit mode when any of the start address, first displayed address or
last displayed address is equal to or greater than 00000000_80000000
(GE 2G). In 64-bit mode with the NOBOTH option in effect, either the
17 byte Offset or Address field is displayed in the scrollable data rows
depending on whether the OFFSET or ADDRESS option has been selected.
When the Offset field is displayed, the current address will be displayed
in the info rows. When the Address field is displayed, the current offset
is displayed in the info rows. In 64-bit mode with the BOTH option in
effect, both the 17 byte Address and 17 byte Offset fields are displayed.
If the AM64 option is in effect then the DISASSME display will always be
in 64-bit display mode.

Specifying addresses in the 2G to 4G range.

* To specify an address in the range 00000000_80000000 to 00000000_FFFFFFFF


you must specify at least one leading 0 (for a total length of 9 or more
hex digits). A hex address of 8 or less hex digits is assumed to be a
31-bit address and bit 0 (bit 32 of the corresponding 64-bit address)
will be cleared to 0.

Subcommands

+---------------+------------------------------------------------------------+
| Subcommand | Function |
+---------------+------------------------------------------------------------+
| AFFINITY | Sets the CPU affinity used for the data displayed. For |
| | additional information, see the AFFINITY subcommand of |
| | the DUMP command. |
+---------------+------------------------------------------------------------+
| ALTER | Alters the contents of storage. For additional |
| | information, see the ALTER subcommand of the DUMP command. |
+---------------+------------------------------------------------------------+
| AND | Alters virtual storage with a logical AND operation. For |
| | more information, see the AND subcommand of the DUMP |
| | command. |
+---------------+------------------------------------------------------------+
| BASE | Sets the base used with base+offset indirect addresses. |
| | For more information, see the BASE subcommand of the DUMP |
| | command. |
+---------------+------------------------------------------------------------+
| COPY | Copies virtual storage data from one address to another. |
| | For more information, see the COPY subcommand of the DUMP |
| | command. |
+---------------+------------------------------------------------------------+
| EVALUATE | Evaluates an address expression and returns the hexadecimal|
| | and decimal values in a message. For more information, |
| | see the EVALUATE subcommand of the DUMP command. |
+---------------+------------------------------------------------------------+
| MOVE | Moves data to a virtual storage address. For more |
| | information, see the MOVE subcommand of the DUMP command. |
+---------------+------------------------------------------------------------+
| OPTIONS | Controls display formatting options. |
+---------------+------------------------------------------------------------+
| OR | Alters virtual storage with a logical OR operation. For |
| | more information, see the OR subcommand of the DUMP |
| | command. |
+---------------+------------------------------------------------------------+
| PGFIX | Fixes a virtual page in real storage. For more |
| | information, see the PGFIX subcommand of the DUMP command. |
+---------------+------------------------------------------------------------+
| PGFREE | Frees a fixed page. For more information, see the PGFREE |
| | subcommand of the DUMP command. |
+---------------+------------------------------------------------------------+
| POST | Posts an ECB with a completion code. For more |
| | information, see the POST subcommand of the DUMP command. |
+---------------+------------------------------------------------------------+
| PROTECT | Makes a virtual page read-only. For more information, |
| | see the PROTECT subcommand of the DUMP command. |
+---------------+------------------------------------------------------------+
| REFRESH | Refreshes the display. |
+---------------+------------------------------------------------------------+
| UNPROT | Makes a virtual page modifiable. For more information, |
| | see the UNPROT subcommand of the DUMP command. |
+---------------+------------------------------------------------------------+
| XLATE | Sets the DUMP translate table option. For more |
| | information, see the XLATE subcommand of the DUMP command. |
+---------------+------------------------------------------------------------+
| XOR | Alters virtual storage with a logical exclusive OR |
| | operation. For more information, see the XOR subcommand |
| | of the DUMP command. |
+---------------+------------------------------------------------------------+

OPTIONS Subcommand

Use the OPTIONS subcommand to control display formatting options.

OPTIONS Subcommand Format

+---------------+------------------------------------------------------------+
| OPTIONS | [disopts] |
+---------------+------------------------------------------------------------+

OPTIONS Subcommand Parameter Values

+----------------------------------------------------------------------------+
| Use any number in any order |
| disopts |
| (Optional) |
+----------------------------------------------------------------------------+
| DATa |
| NOData |
| DECDisp |
| HEXDisp |
| DEPth nn |
| Confirm |
| NOConfirm |
| Floatpt |
| NOFloatpt |
| DECRel |
| HEXRel |
| OWner |
| NOOWner |
| Offset |
| Address |
| Both |
| NOBoth |
| AM64 |
| NOAM64 |
| Legend |
| NOLegend |
+----------------------------------------------------------------------------+

OPTIONS Subcommand disopts Parameter Values Explained

+---------------+------------------------------------------------------------+
| Value | Explanation |
+---------------+------------------------------------------------------------+
| Data | Control whether or not data longer that eight bytes is |
| NOData | truncated at eight bytes (NODATA) or continued on |
| | subsequent lines (DATA). NODATA is the default. |
+---------------+------------------------------------------------------------+
| DECDisp | Controls whether displacements are displayed as decimal |
| HEXDisp | or hexadecimal numbers. DECDISP is the default. The |
| | DECDISP/HEXDISP value will be displayed in the "Options" |
| | info line as DDISP and HDISP. These values are also valid |
| | as operands on the OPTIONS subcommand. |
+---------------+------------------------------------------------------------+
| DEPth nn | Depth of the lookahead search to determine whether an |
| | apparently valid instruction is really an instruction and |
| | not data. The value must be a decimal number from 0 |
| | through 32. The default is 25. |
+---------------+------------------------------------------------------------+
| Confirm | Controls whether or not the storage altering subcommands |
| NOConfirm | of DISASSEM will require confirmation from the user prior |
| | to being executed. These subcommands include, ALTER, AND, |
| | COPY, PGFIX, PGFREE, MOVE, OR, PROTECT, UNPROT, and XOR. |
| | CONFIRM is the default. The CONFIRM/NOCONFIRM value will |
| | be displayed in the "Options" info line as CNFM and NOCNFM.|
| | These values are also valid as operands on the OPTIONS |
| | subcommand. |
+---------------+------------------------------------------------------------+
| Floatpt | Controls whether or not floating point instructions are to |
| NOFloatpt | be recognized as valid. The FLOATPT/NOFLOATPT value will |
| | be displayed in the "Options" info line as FLPT and NOFLPT.|
| | These values are also valid as operands on the OPTIONS |
| | subcommand. |
+---------------+------------------------------------------------------------+
| DECRel | Controls whether relative offsets (for branch relative |
| HEXRel | instructions) will be displayed as decimal or hexadecimal |
| | numbers. HEXREL is the default. The DECREL/HEXREL value |
| | will be displayed in the "Options" info line as DREL and |
| | HREL. These values are also valid as operands of the |
| | OPTIONS subcommand. |
+---------------+------------------------------------------------------------+
| OWner | Control whether the common storage owner fields (Owner and |
| NOOWner | ASID) are displayed in the information lines. OWNER is |
| | the default. The OWNER/NOOWNER value will be displayed |
| | in the "Options" info line as OWN and NOOWN. |
+---------------+------------------------------------------------------------+
| Offset | Controls whether the 17-byte offset or address field |
| Address | should be displayed when in 64-bit mode. OFFSET is the |
| | default. The OFFSET/ADDRESS value will be displayed in |
| | the "Options" info line as OFFS and ADDR. These values |
| | are also valid as operands on the OPTIONS subcommand. |
+---------------+------------------------------------------------------------+
| AM64 | Controls whether or not 64-bit display mode should be used |
| NOAM64 | regardless of the current address range displayed. With |
| | NOAM64 (the default) 64-bit display mode is used only when |
| | the displayed address range either starts or ends with an |
| | address above 2G. With AM64 the 64-bit display mode is |
| | always used. |
+---------------+------------------------------------------------------------+
| Both | Controls whether or not both a 64-bit address and a 64-bit |
| NOBoth | offset will displayed. When NOBOTH is in effect (the |
| | default) and the display is in 64-bit mode either the |
| | 64-bit address or the 64-bit offset is displayed depending |
| | on the setting of the ADDRESS/OFFSET option. When BOTH is |
| | in effect, both a 64-bit address and a 64-bit offset will |
| | be displayed if the number of screen columns is greater |
| | than or equal to 150. When BOTH is in effect and DAT is |
| | ON, the DAT info field is not displayed. When BOTH is in |
| | effect and DAT is OFF, the DAT info field will overlay the |
| | AR info field. |
+---------------+------------------------------------------------------------+
| Legend | Controls whether or not the Legend line is displayed in |
| NOLegend | the info area. The Legend line contains a description of |
| | the special characters used in the hex dump portion of the |
| | display to indicate the type of error that occurred while |
| | attempting to gather the display data. NOLEGEND is the |
| | default. The LEGEND/NOLEGEND value will be displayed |
| | in the "Options" info line as LGND and NOLGND. These |
| | abbreviations are also valid as operands on the OPTIONS |
| | subcommand. |
+---------------+------------------------------------------------------------+
| EXTRact | Requests that the current option settings be extracted into|
| | a TSO CLIST or REXX exec variable. The variable created |
| | or updated is named SYSV_OPTIONS_DISASSEM. This |
| | keyword is only valid when the product is running under a |
| | TSO CLIST or REXX EXEC. EXTRACT can be specified alone or |
| | in combination with any other OPTIONS keywords. |
+---------------+------------------------------------------------------------+

OPTIONS Subcommand Notes

* The DISASSEM command uses a rule for decoding storage into instructions.
An instruction must be followed by the DEPTH number of valid instructions to
be considered valid. An instruction is also considered valid if the
lookahead search encounters an unconditional branch instruction, a
branch-and-link-type instruction with R1 as the first operand, a BAL
instruction with R15 as the first operand, or a BSM instruction with R0
as the first operand and anything but R0 as the second operand.

* In the API and BATCH interfaces, the actual value of the CONFIRM/NOCONFIRM
option is ignored and a value of NOCONFIRM is assumed.

REFRESH Subcommand

The REFRESH subcommand refreshes the displayed data.

REFRESH Subcommand Format

+----------------------------------------------------------------------------+
| REFRESH |
+----------------------------------------------------------------------------+

Messages

DASM001E [cmdn] command invalid with SORT or SELECT active


The DISASSEM subcommand [cmdn] is not valid when SORT
or SELECT is active. Clear any sorting or selection
and retry the original command.

DASM002E [comname] command invalid with DAT OFF

The DISASSEM command or subcommand [comname] is not valid when DAT


is OFF.

DASM003E Address parameter required

The DISASSEM command [address] parameter is required.

DASM004E [subcmd] invalid, no DISASSEM data displayed

The DISASSEM subcommand [subcmd] is not valid when no DISASSEM


data is displayed.

DASM005E ALTER command invalid with NODATA option

The ALTER subcommand of the DISASSEM command is not valid with


OPTIONS NODATA in effect. Enter the OPTIONS DATA command and
retry the ALTER subcommand.

DASM006E [cmdnam] command invalid in AR mode

Informational only.

DLCOPY Help
-------------------------------------------------------------------------------

DLCOPY Command

The DLCOPY function command and the DLCOPY panel (a COPY


line command from the DLLIST command) copy SYSVIEW DATALIB
data members.

Command Syntax

The following DLCOPY syntax applies only to the DLCOPY


function command. The DLCOPY panel is invoked by a COPY
line command from the DLLIST display and does not have
any parameters.

+------------------+--------------------------------------------------+
| DLCopy | sdatakey tdatakey [sdatalib] [tdatalib] [opts] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| sdatakey | The sdatakey parameter is the data key of the |
| tdatakey | DATALIB source data you want to copy. The |
| | tdatakey parameter is the target data key. |
| | Both of these parameters are required. |
| | |
| | A data key is comprised of four parts, separated |
| | by periods. |
| | |
| | dataid.sysname.ssid.build |
| | |
| | The dataid part is the data identifier. The |
| | sysname part is the system name from which |
| | the data was written. The ssid part is the |
| | subsystem identifier from which the data was |
| | written and the build part is the product build |
| | number. Only the dataid is required. The |
| | sysname, ssid, and build will default to the |
| | current system name, subsystem identifier, and |
| | build number. If you want to specify an ssid but |
| | want to take the default system name, you must |
| | still specify the period for the omitted part. |
| | You can also use an asterisk ("*") to request |
| | the default for the system name, subsystem |
| | identifier, and build number. |
| | |
| | For example: |
| | |
| | DATANAME..ABCD |
| | DATANAME.*.*.1234 |
| | |
| | In the first example you will get the default |
| | system name and build. In the second, you will |
| | get the default system name and subsystem |
| | identifier. |
| | |
| | When specifying the tdatakey parm, you can use |
| | an equal sign ("=") for any of the parts to |
| | indicate that the corresponding part from the |
| | sdatakey parm should be used or you can use |
| | an asterisk ("*") to request that the default |
| | be used. |
| | |
| | The special dataid of $$$INDEX can not be used |
| | in either the sdatakey or tdatakey parms. |
| | |
| | If the sdatakey and tdatakey parameters are the |
| | same then you must specify different source and |
| | target DATALIB data sets (see the sdsn and tdsn |
| | parameters below). |
| | |
| | The sdatakey must already exist in the source |
| | DATALIB dataset and the tdatakey must not exist |
| | in the target DATALIB data set unless you have |
| | also specified the REPLACE option (see below). |
| | |
| | When the panel interface to the DLCOPY command |
| | (a COPY line command from the DLLIST display) |
| | is used, the source data key is already filled |
| | in on the panel and cannot be changed. |
| | |
+------------------+--------------------------------------------------+
| sdatalib | The source DATALIB data set name. If this |
| | parameter is omitted, the default is the DATALIB |
| | dataset specified by the Dsn-System-DATALIB |
| | parameter in the System Configuration Options |
| | member. You may also specify a sdatalib of |
| | "*" to request the default DATALIB dataset name. |
| | |
| | When the panel interface to the DLCOPY command |
| | (a COPY line command from the DLLIST display) |
| | is used, the source datalib name is already |
| | filled in on the panel and cannot be changed. |
| | |
+------------------+--------------------------------------------------+
| tdatalib | The target DATALIB data set name. If this |
| | parameter is omitted, the default is the source |
| | DATALIB dataset name (which may have also been |
| | allowed to default). You may also specify a |
| | tdatalib of "*" to request the default DATALIB |
| | dataset name or a tdatalib of "=" to request the |
| | same dataset name as the sdatalib. |
| | |
| | When the panel interface to the DLCOPY command |
| | (a COPY line command from the DLLIST display) |
| | is used, the target datalib name is initially |
| | set to the same value as the source datalib |
| | name (the DATALIB data set listed by the DLIST |
| | command). Any changes to the target datalib |
| | name will be remembered from one COPY line |
| | command to the next for the duration of the |
| | DLLIST command. |
| | |
+------------------+--------------------------------------------------+
| opts | Any number of option keywords selected from the |
| | list below: |
| | |
| | Replace Controls whether or not the |
| | NOReplace specified target data key is |
| | allowed to replace an existing |
| | member with the same key. |
| | The default is NOREPLACE. |
| | |
| | Confirm Controls whether you are |
| | NOConfirm prompted to confirm your intent |
| | to copy the DATALIB data. |
| | The default is CONFIRM. |
| | |
| | Msg Controls whether an "Copy |
| | NOMsg complete" message is generated. |
| | Error messages are always |
| | generated. The default is MSG. |
| | |
| | The default values for the options listed above |
| | can be changed using the DLOPTION command. The |
| | defaults listed here are the original default |
| | values as the product is distributed. |
| | |
| | When the panel interface to the DLCOPY command |
| | (a COPY line command from the DLLIST display) |
| | is used, the REPLACE/NOREPLACE option is a YES |
| | or NO value in the "Replace" option field, the |
| | MSG/NOMSG option is a YES or NO value in the |
| | "Message" field, and the CONFIRM/NOCONFIRM |
| | option is not available. Any changes to the |
| | Options fields will be remembered from one COPY |
| | line command to the next for the duration of the |
| | DLLIST command. |
| | |
+------------------+--------------------------------------------------+

Notes

For this instance of SYSVIEW, the use of an "*" to request a


default value will result in the following substitutions:

sysname MVS1
ssid GSVX
build 1010
datalib sysview.CNM4BDAT
DLDELETE

DLDELETE Command

The DLDELETE function command and the DLDELETE panel (a DELETE


line command from the DLLIST command) delete SYSVIEW DATALIB
data members.

Command Syntax

+------------------+--------------------------------------------------+
| DLDelete | datakey [datalib] [opts] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| datakey | The data key of the DATALIB data you want to |
| | delete. This parameter is required. The data |
| | key is comprised of 4 parts, separated by |
| | periods. |
| | |
| | dataid.sysname.ssid.build |
| | |
| | The dataid part is the data identifier. The |
| | sysname part is the system name from which |
| | the data was written. The ssid part is the |
| | subsystem identifier from which the data was |
| | written and the build part is the product build |
| | number. Only the dataid is required. The |
| | sysname, ssid, and build will default to the |
| | current system name, subsystem identifier, and |
| | build number. If want to specify an ssid but |
| | want to take the default system name, you must |
| | still specify the period for the omitted part. |
| | You can also use an asterisk ("*") to request |
| | request default for the system name, subsystem |
| | identifier, and build number. |
| | |
| | For example: |
| | |
| | DATANAME..ABCD |
| | DATANAME.*.*.1234 |
| | |
| | In the first example you will get the default |
| | system name and build. In the second, you will |
| | get the default system name and subsystem |
| | identifier. |
| | |
| | The special dataid of $$$INDEX can not be |
| | deleted. |
| | |
| | When the panel interface to the DLDELETE command |
| | (a DELETE line command from the DLLIST display) |
| | is used, the source data key is already filled |
| | in on the panel and cannot be changed. |
| | |
+------------------+--------------------------------------------------+
| datalib | The dataset name of the DATALIB that contains |
| | the DATALIB member you want to delete. If this |
| | parameter is omitted, the default is the DATALIB |
| | dataset specified by the Dsn-System-DATALIB |
| | parameter in the System Configuration Options |
| | member. You may also specify a datalib of "*" |
| | to request the default DATALIB dataset name. |
| | |
| | When the panel interface to the DLDELETE command |
| | (a DELETE line command from the DLLIST display) |
| | is used, the source datalib name is already |
| | filled in on the panel and cannot be changed. |
| | |
+------------------+--------------------------------------------------+
| opts | Any number of option keywords selected from the |
| | list below: |
| | |
| | Confirm Controls whether you are |
| | NOConfirm prompted to confirm your intent |
| | to delete the DATALIB data. |
| | The default is CONFIRM. |
| | |
| | Msg Controls whether an "Delete |
| | NOMsg complete" message is generated. |
| | Error messages are always |
| | generated. The default is MSG. |
| | |
| | The default values for the options listed above |
| | can be changed using the DLOPTION command. The |
| | defaults listed here are the original default |
| | values as the product is distributed. |
| | |
| | When the panel interface to the DLDELETE command |
| | (a DELETE line command from the DLLIST display) |
| | is used, the MSG/NOMSG option is a YES or NO |
| | value in the "Message" field and the CONFIRM/ |
| | NOCONFIRM option is not available. Any changes |
| | to the Options input fields will be remembered |
| | from one DELETE line command to the next for the |
| | duration of the DLLIST command. |
| | |
+------------------+--------------------------------------------------+

Notes

For this instance of SYSVIEW, the use of an "*" to request a


default value will result in the following substitutions:

sysname MVS1
ssid GSVX
build 1010
datalib sysview.CNM4BDAT
DLEXPORT

DLEXPORT Command

The DLEXPORT function command and the DLEXPORT panel (an


EXPORT line command from the DLLIST command) export SYSVIEW
DATALIB data members to an external PDS or PDSE.

Command Syntax

+------------------+--------------------------------------------------+
| DLExport | sdatakey sdatalib tdsname(tmember) [opts] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| sdatakey | The data key of the DATALIB data you want to |
| | export. This parameter is required. The data |
| | key is comprised of 4 parts, separated by |
| | periods. |
| | |
| | dataid.sysname.ssid.build |
| | |
| | The dataid part is the data identifier. The |
| | sysname part is the system name from which |
| | the data was written. The ssid part is the |
| | subsystem identifier from which the data was |
| | written and the build part is the product build |
| | number. Only the dataid is required. The |
| | sysname, ssid, and build will default to the |
| | current system name, subsystem identifier, and |
| | build number. If want to specify an ssid but |
| | want to take the default system name, you must |
| | still specify the period for the omitted part. |
| | You can also use an asterisk ("*") to request |
| | request default for the system name, subsystem |
| | identifier, and build number. |
| | |
| | For example: |
| | |
| | DATANAME..ABCD |
| | DATANAME.*.*.1234 |
| | |
| | In the first example you will get the default |
| | system name and build. In the second, you will |
| | get the default system name and subsystem |
| | identifier. |
| | |
| | The special dataid of $$$INDEX can not be |
| | exported. |
| | |
| | When the panel interface to the DLEXPORT command |
| | (an EXPORT line command from the DLLIST display) |
| | is used, the source data key is already filled |
| | in on the panel and cannot be changed. |
| | |
+------------------+--------------------------------------------------+
| sdatalib | The source DATALIB data set name. This parameter |
| | is required. You may specify this parameter as |
| | "*" to request the default DATALIB data set name |
| | (the data set specified by the Dsn-System-DATALIB|
| | parameter in the System Configuration Options |
| | member). |
| | |
| | When the panel interface to the DLEXPORT command |
| | (an EXPORT line command from the DLLIST display) |
| | is used, the source datalib name is already |
| | filled in on the panel and cannot be changed. |
| | |
+------------------+--------------------------------------------------+
| tdsname(tmember) | The target dataset name and member name to which |
| | the source DATALIB member is to be exported. |
| | This parameter is required. The target data set |
| | must be a PDS or PDSE and it must be RECFM=F and |
| | LRECL=80. |
| | |
| | When the panel interface to the DLEXPORT command |
| | (an EXPORT line command from the DLLIST display) |
| | is used, the target data set name and member name|
| | are initially set to blanks. Any changes to the |
| | target data set name and member name will be |
| | remembered from EXPORT line command to the next |
| | for the duration of the DLLIST command. |
| | |
+------------------+--------------------------------------------------+
| opts | Any number of option keywords selected from the |
| | list below: |
| | |
| | Old Controls the disposition used |
| | Shr when allocating the target data |
| | set. The default is OLD. |
| | |
| | Replace Controls whether or not the |
| | NOReplace specified target member is |
| | allowed to replace an existing |
| | member of the same name in the |
| | target data set. The default |
| | is NOREPLACE. |
| | |
| | IDent Controls whether or not |
| | NOIDent identification comment records |
| | are written as a part of the |
| | exported data. The format of |
| | the identification records is |
| | described below in the Notes |
| | section. The default is IDENT. |
| | You must specify IDENT if you |
| | want to be able to use the |
| | DLIMPORT command to import back |
| | into DATALIB the data you are |
| | now attemping to export. |
| | |
| | Confirm Controls whether you are |
| | NOConfirm prompted to confirm your intent |
| | to export the DATALIB data. |
| | The default is CONFIRM. |
| | |
| | Msg Controls whether an "Export |
| | NOMsg complete" message is generated. |
| | Error messages are always |
| | generated. The default is MSG. |
| | |
| | The default values for the options listed above |
| | can be changed using the DLOPTION command. The |
| | defaults listed here are the original default |
| | values as the product is distributed. |
| | |
| | When the panel interface to the DLEXPORT command |
| | (an EXPORT line command from the DLLIST display) |
| | is used, the SHR/OLD option is a value in the |
| | "Disp" field, the REPLACE/NOREPLACE option is a |
| | YES or NO value in the "Replace" option field, |
| | the MSG/NOMSG option is a YES or NO value in the |
| | "Message" field, and the CONFIRM/NOCONFIRM |
| | option is not available. Any changes to the |
| | Options fields will be remembered from one |
| | EXPORT line command to the next for the duration |
| | of the DLLIST command. |
| | |
+------------------+--------------------------------------------------+

Notes

* For this instance of SYSVIEW, the use of an "*" to


request a default value will result in the following
substitutions:

sysname MVS1
ssid GSVX
build 1010
datalib sysview.CNM4BDAT

* If the IDENT option is in effect the following


identification records will be written as the first
eight exported records.

*IDENT [xfmt] [xtype] [xvers] [xlen] [xnum] [xchksum]


*IDENT [datakey]
*IDENT [datalib]
*IDENT [cfmt] [ctype] [cvers] [clen] [cnum]
*IDENT [sysname] [jobname] [taskid] [userid] [date] [time]
*IDENT Do not alter these IDENT records. They are used by the
*IDENT DLIMPORT command to import this data back into DATALIB.
*IDENT If they are modified, the DLIMPORT command will fail.

You should not alter these IDENT records in any


way if you expect to import this exported data
back into DATALIB using the DLIMPORT command.
DLIMPORT

DLIMPORT Command

The DLIMPORT function command and the DLIMPORT panel (an


IMPORT line command from the DLLIST command) import SYSVIEW
DATALIB data members from an external PDS or PDSE.

Command Syntax

+------------------+--------------------------------------------------+
| DLIMport | tdatakey tdatalib sdsname(smember) [opts] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| tdatakey | The data key of the DATALIB data you want to |
| | import. This parameter is required. The data |
| | key is comprised of 4 parts, separated by |
| | periods. |
| | |
| | dataid.sysname.ssid.build |
| | |
| | The dataid part is the data identifier. The |
| | sysname part is the system name from which |
| | the data was written. The ssid part is the |
| | subsystem identifier from which the data was |
| | written and the build part is the product build |
| | number. Only the dataid is required. The |
| | sysname, ssid, and build will default to the |
| | current system name, subsystem identifier, and |
| | build number. If want to specify an ssid but |
| | want to take the default system name, you must |
| | still specify the period for the omitted part. |
| | You can also use an asterisk ("*") to request |
| | request default for the system name, subsystem |
| | identifier, and build number. |
| | |
| | For example: |
| | |
| | DATANAME..ABCD |
| | DATANAME.*.*.1234 |
| | |
| | In the first example you will get the default |
| | system name and build. In the second, you will |
| | get the default system name and subsystem |
| | identifier. |
| | |
| | When specifying the tdatakey parm, you can use |
| | an equal sign ("=") for any of the parts to |
| | indicate that the corresponding part from the |
| | source datakey should be used or you can use |
| | an asterisk ("*") to request that the default |
| | be used. The source datakey is taken from the |
| | IDENT records that must be present in the data |
| | specified by the sdsname(smember) parm described |
| | below. |
| | |
| | The special dataid of $$$INDEX can not be |
| | iported. |
| | |
| | When the panel interface to the DLIMPORT command |
| | (an IMPORT line command from the DLLIST display) |
| | is used, the target data key is already filled |
| | in on the panel and cannot be changed. |
| | |
+------------------+--------------------------------------------------+
| tdatalib | The target DATALIB data set name. This parameter |
| | is required. You may specify this parameter as |
| | "*" to request the default DATALIB data set name |
| | (the data set specified by the Dsn-System-DATALIB|
| | parameter in the System Configuration Options |
| | member). |
| | |
| | When the panel interface to the DLIMPORT command |
| | (an IMPORT line command from the DLLIST display) |
| | is used, the target datalib name is already |
| | filled in on the panel and cannot be changed. |
| | |
+------------------+--------------------------------------------------+
| sdsname(smember) | The source dataset name and member from which |
| | the target DATALIB member is to be imported. |
| | This parameter is required. The source data set |
| | must be a PDS or PDSE and it must be RECFM=F and |
| | LRECL=80. The source member must also have been |
| | written with the DLEXPORT command and the IDENT |
| | option must have been specified. |
| | |
| | When the panel interface to the DLIMPORT command |
| | (an IMPORT line command from the DLLIST display) |
| | is used, the source data set name and member name|
| | are initially set to blanks. Any changes to the |
| | source data set name and member name will be |
| | remembered from IMPORT line command to the next |
| | for the duration of the DLLIST command. |
| | |
+------------------+--------------------------------------------------+
| opts | Any number of option keywords selected from the |
| | list below: |
| | |
| | Replace Controls whether or not the |
| | NOReplace specified target data key is |
| | allowed to replace an existing |
| | member with the same key. |
| | The default is NOREPLACE. |
| | |
| | Confirm Controls whether you are |
| | NOConfirm prompted to confirm your intent |
| | to import the DATALIB data. |
| | The default is CONFIRM. |
| | |
| | Msg Controls whether an "Import |
| | NOMsg complete" message is generated. |
| | Error messages are always |
| | generated. The default is MSG. |
| | |
| | The default values for the options listed above |
| | can be changed using the DLOPTION command. The |
| | defaults listed here are the original default |
| | values as the product is distributed. |
| | |
| | When the panel interface to the DLIMPORT command |
| | (an IMPORT line command from the DLLIST display) |
| | is used, the MSG/NOMSG option is a YES or NO |
| | value in the "Message" field, and the REPLACE/ |
| | NOREPLACE and CONFIRM/NOCONFIRM options are not |
| | available. Any changes to the Options fields |
| | will be remembered from one IMPORT line command |
| | to the next for the duration of the DLLIST |
| | command. |
| | |
+------------------+--------------------------------------------------+

Notes

* For this instance of SYSVIEW, the use of an "*" to


request a default value will result in the following
substitutions:

sysname MVS1
ssid GSVX
build 1010
datalib sysview.CNM4BDAT
DLINIT

DLINIT Command

The DLINIT command initializes a SYSVIEW DATALIB data set.


Initializing a DATALIB data set deletes all of the data members
in the data set.

Command Syntax

+------------------+--------------------------------------------------+
| DLINit | datalib | * [opts] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| datalib | The data set name of the DATALIB that you want |
| | to initialize. This parameter is required. You |
| | may specify a datalib of "*" to request the |
| | default DATALIB data set name specified by the |
| | Dsn-System-DATALIB parameter in the System |
| | Configuration Options member. |
| | |
+------------------+--------------------------------------------------+
| opts | Any number of option keywords selected from the |
| | list below: |
| | |
| | Confirm Controls whether you are |
| | NOConfirm prompted to confirm your intent |
| | to initialize the DATALIB data |
| | set. The default is CONFIRM. |
| | |
| | Msg Controls whether an "Initialize |
| | NOMsg complete" message is generated. |
| | Error messages are always |
| | generated. The default is MSG. |
| | |
| | Verify Controls whether or not the |
| | NOVerify initialization process will |
| | verify that the $$$INDEX member |
| | is present in the DATALIB data |
| | set before proceeding. If the |
| | $$$INDEX member is not present, |
| | the initialize process fails. |
| | The default is VERIFY. |
| | |
| | Index Controls whether or not an |
| | NOIndex empty $$$INDEX member will be |
| | written to the DATALIB after |
| | deleting all members. The |
| | default is INDEX. |
| | |
| | Note that by specifying NOVERIFY |
| | and NOINDEX you can empty out |
| | any arbitrary PDS or PDSE. |
| | |
| | The default values for the options listed above |
| | can be changed using the DLOPTION command. The |
| | defaults listed here are the original default |
| | values as the product is distributed. |
| | |
+------------------+--------------------------------------------------+

Notes

For this instance of SYSVIEW, the use of an "*" to


request a default value will result in the following
substitutions:

sysname MVS1
ssid GSVX
build 1010
datalib sysview.CNM4BDAT
DLLIST

DLLIST Command

DLLIST displays the contents of a SYSVIEW DATALIB library.

Command Syntax

+------------------+--------------------------------------------------+
| DLList | [datalib] |
+------------------+--------------------------------------------------+

Parameters

+------------------+--------------------------------------------------+
| Parameter | Description |
+------------------+--------------------------------------------------+
| datalib | The data set name of the DATALIB you want to |
| | list. If this parameter is omitted, then |
| | the default is the DATALIB data set specified |
| | by the Dsn-System-DATALIB parameter in the |
| | System Configuration Options member. |
+------------------+--------------------------------------------------+

Information Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| Datalib | The DATALIB data set name. |
+------------------+--------------------------------------------------+
| Pages | The number of 4K pages allocated to the DATALIB |
| | data set. This field will display "n/a" for a |
| | non-SMS managed PDSE. |
+------------------+--------------------------------------------------+
| Inuse | The number of 4K pages in use in the DATALIB |
| | data set and the percent of the pages allocated |
| | that are in use. The in use percentage field |
| | will display "n/a" for a non-SMS managed PDSE. |
+------------------+--------------------------------------------------+

Data Fields

+------------------+--------------------------------------------------+
| Field | Description |
+------------------+--------------------------------------------------+
| DataId | The data identifier of the member. |
+------------------+--------------------------------------------------+
| System | The system name of the member owner. |
+------------------+--------------------------------------------------+
| SSId | The subsystem identifier of the member owner. |
+------------------+--------------------------------------------------+
| Bld | The build number of the member owner. |
+------------------+--------------------------------------------------+
| Description | The description. |
+------------------+--------------------------------------------------+
| Status | The status of the member. Values can be: |
| | |
| | INDEX This is the index member. It can |
| | not be deleted. |
| | |
| | OLD_KEEP The dataid.system.ssid.build is |
| | older than the current build and |
| | no newer (up to current) build |
| | was found. It is unknown if |
| | this member can be deleted. |
| | |
| | OLD_DEL The dataid.system.ssid.build is |
| | older than the current build and |
| | a newer (up to current) build was |
| | found. This member can be deleted. |
| | |
| | CURRENT The dataid.system.ssid.build is |
| | for the current build. This member |
| | should not be deleted. |
| | |
| | NEW The dataid.system.ssid.build is |
| | for a build newer than the current |
| | build. This member should not be |
| | deleted. |
| | |
| | DELETED The DATALIB member was deleted |
| | with the DELETE or DLDELETE line |
| | command and the display has not |
| | yet been refreshed. No further |
| | action is allowed. |
| | |
| | Note that 1010 is the current build number |
| | for this instance of SYSVIEW. |
+------------------+--------------------------------------------------+
| Member | The member name. |
+------------------+--------------------------------------------------+
| Vers | The data version. |
+------------------+--------------------------------------------------+
| Fmt | The member data format. Values can be |
| | |
| | REC Records |
| | BLK Block |
| | |
+------------------+--------------------------------------------------+
| Type | The member data type. Values can be |
| | |
| | CHAR Character data |
| | HEX Hex data |
| | UNDF Undefined data |
| | |
+------------------+--------------------------------------------------+
| Length | The record length for a data type of REC or |
| | the block length for a data type of BLK. |
+------------------+--------------------------------------------------+
| Number | The number of records for a data type of REC or |
| | the number of blocks for a data type of BLK. |
+------------------+--------------------------------------------------+
| Total | The total length of the data (Len times Num |
| | plus fixed control length of 480). |
+------------------+--------------------------------------------------+
| Pages | The number of 4K pages allocated for the member. |
+------------------+--------------------------------------------------+
| UpCount | The number of times the data has been updated. |
+------------------+--------------------------------------------------+
| UpDate | The date of the last data update. |
+------------

You might also like