VERBEXIT subcommand — run an installation-supplied or an IBM-supplied verb exit routine

Use the VERBEXIT subcommand to run an installation-supplied or IBM-supplied verb exit routine.

Syntax

 { VERBEXIT }  { pgmname  }
 { VERBX    }  { verbname }
               [ 'parameter [,parameter]...' ]
               [ AMASK(mask) ]
               [ SYNTAX | NOSYNTAX ]
               [ TOC | NOTOC  ]

-------- SETDEF-Defined Parameters -------------------------
Note: You can override the following SETDEF parameters.
See SETDEF subcommand — set defaults.

               [ ACTIVE | MAIN | STORAGE          ]
               [ DSNAME(dsname) | DATASET(dsname) ]
               [ FILE(ddname) | DDNAME(ddname)    ]
               [ PATH(path-name)     ]
               [ PRINT | NOPRINT ]
               [ TERMINAL | NOTERMINAL ]
               [ TEST | NOTEST ]

Parameters

pgmname

Specifies a verb exit routine. The pgmname can be a maximum of 8 alphanumeric characters; the first character must be alphabetic. An installation-supplied verb exit routine must reside in a load module library available to IPCS, such as a step library, job library, or link library. For information about writing verb exit routines, see z/OS MVS IPCS Customization.

verbname

Specifies the name of a verb exit routine. For IPCS to access an installation-supplied verb exit through a verb name, your installation needs to either create or modify the BLSCUSER parmlib member.

An installation-supplied verb exit routine must reside in a load module library available to IPCS, such as a step library, job library, or link library.

For information about the BLSCUSER parmlib member and on writing verb exit routines, see z/OS MVS IPCS Customization.

Table 1 lists the verb names of IBM-supplied verb exit routines. These verb exit routines are defined in SYS1.PARMLIB members. For each verb name, the table provides a cross reference telling where you can find an explanation of the verb name, its optional parameters if applicable, and information concerning the component, function, or product-specific data that these verb exit routines process.

Note: Other products might have a dump formatter available for use with IPCS. Check the related product documentation for information.

Table 1. Verb name summary
Verb Name	Component, Product, or Function	Where Documented
ALCWAIT	Allocation	See VERBEXIT ALCWAIT subcommand — list jobs waiting for devices
AOMDATA	Asynchronous operations manager	z/OS DFSMSdfp Diagnosis
ASMDATA	Auxiliary storage management	See VERBEXIT ASMDATA subcommand — format auxiliary storage manager data
AVMDATA	Availability manager	See VERBEXIT AVMDATA subcommand — format availability manager data
BLSAIPST	System initialization	See VERBEXIT BLSAIPST subcommand — format system initialization data
CBDATA	Component Broker	See VERBEXIT CBDATA subcommand — format component broker data
CICSDATA	Customer Information Control System	&cicsicurl;
DAEDATA	Dump analysis and elimination	See VERBEXIT DAEDATA subcommand — format dump analysis and elimination data
DSNWDMP	DB2®	&imsicurl;
GRSTRACE	Global resource serialization	See VERBEXIT GRSTRACE subcommand — format Global Resource Serialization data
HASMFMTM	JES2	See z/OS JES2 Diagnosis
IEAVTSFS	Dumping services	See VERBEXIT IEAVTSFS subcommand — format SVC dump measurements and statistics report
IEFENFVX	Event notification facility (ENF)	See VERBEXIT IEFENFVX subcommand — list ENF listeners
IEFIVAWT	Allocation	See VERBEXIT IEFIVAWT subcommand — list pending XCF work for tape allocation
IEFIVIGD	Allocation	See VERBEXIT IEFIVIGD subcommand — list global tape device information
IMSDUMP	Information Management System (IMS™)	&imsicurl;
IRLM	Information Management System (IMS)	&imsicurl;
JESXCF	JES common coupling services MVS™ component (JES XCF)	See VERBEXIT JESXCF subcommand — format data for JES XCF component
JES3	JES3	z/OS JES3 Diagnosis
LEDATA	Language Environment®	See VERBEXIT LEDATA subcommand — format Language Environment data
LOGDATA	Logrec buffer records	See VERBEXIT LOGDATA subcommand — format logrec buffer records
MMSDATA	MVS message service	See VERBEXIT MMSDATA subcommand — format MVS message service data
MTRACE	Master trace table	See VERBEXIT MTRACE subcommand — format master trace entries
NUCMAP	Modules in the nucleus	See VERBEXIT NUCMAP subcommand — map modules in the nucleus
SADMPMSG	Stand-alone dump message log	See VERBEXIT SADMPMSG subcommand — format stand-alone dump message log
SMSDATA SMSXDATA	DFP Storage Management Subsystem	z/OS DFSMSdfp Diagnosis
SRMDATA	System resource manager	See VERBEXIT SRMDATA subcommand — format System Resource Manager data
SUMDUMP	SVC summary dump data	See VERBEXIT SUMDUMP subcommand — format SVC summary dump data
SYMPTOM	Symptom string	See VERBEXIT SYMPTOM subcommand — format symptom string
TSODATA	Time Sharing Option	z/OS TSO/E System Diagnosis: Data Areas
VSMDATA	Virtual storage management	See VERBEXIT VSMDATA subcommand — format virtual storage management data
VTAMMAP	Virtual Telecommunications Access Method (VTAM®)	VTAM Diagnosis

parameter

Specifies a parameter string to be passed to either an IBM-supplied or an installation-supplied verb exit routine.

Enclose the parameter string in apostrophes. When IPCS passes the string to the exit routine, it omits the apostrophes. If the string parameter itself includes an apostrophe, enter a pair of apostrophes; IPCS will convert them to a single apostrophe when passing the string to the exit routine.

Verb exits are responsible for parsing the string. When specifying keyword strings, be aware of the following conditions:

Spell out the full form of the keyword strings expected by the verb exit. Not all of the verb exits recognize truncated keywords.
Use commas to separate parameters when you specify more than one parameter and the verb exit syntax indicates comma separators are appropriate. Avoid using blanks or horizontal tabulation character to separate parameters, even if the TSO syntax rule says they are interchangeable with commas.
Follow the special syntax rules required by verb exit routines, if any. Authors of verb exit routines are allowed to implement special syntax rules for the parameters, depending on the primary usage of the routines. For example, verb exit routines provided by DB2 might implement SQL rules rather than TSO rules.

For IBM-supplied verb exit routines, the parameter string that can be specified is described in this book under the corresponding verb name.

For installation-supplied verb exit routines, the parameter string that can be specified must have its content and meaning defined by the installation-supplied exit routine.

AMASK(mask)

Specifies an integer mask that VERBEXIT is to AND to the dump addresses passed by the exit to the storage access and format service routines. Only X'00FFFFFF', X'7FFFFFFF' or the corresponding decimal or binary values are accepted.

SYNTAX or NOSYNTAX

Specifies or suppresses a syntax check of the parameter string passed to the verb exit routine. SYNTAX specifies the syntax check. NOSYNTAX suppresses the syntax check and is the default.

TOC or NOTOC

Specifies or suppresses table or contents, print file, and terminal output.

The TOC option anticipates that the exit will write a report. IPCS writes a standard table of contents entry before giving the exit control. An error message is written if no report is written.

The NOTOC option suppresses the output.

Return Codes

Code	Explanation
12	Severe error, an error condition or user request forced early termination of the subcommand.
16	Terminating error, an error condition from a called service routine forced an early termination of the subcommand.
other	An exit generated return code.

Example: Invoke an installation-supplied verb exit represented by the verb name HISTORY.
- Action
```
COMMAND ===>  verbexit history 'rb,56b34'
```
- Result
  The installation-supplied verb exit routine HISTORY receives the parameter string RB,56B34.