An overview of the IBM MQ utilities for z/OS

Use this topic as a reference to the different categories of utilities.

This topic introduces the IBM MQ utility programs that are provided to help you perform various administrative tasks. The utility programs are described in the subsequent sections:

Purpose Function See topic
Format VSAM data sets as IBM MQ page sets. FORMAT Formatting page sets (FORMAT) on z/OS
Control recovery processing used for IBM MQ page sets. FORMAT Formatting page sets (FORMAT) on z/OS
Extract page set information. PAGEINFO Page set information (PAGEINFO) on z/OS
Copy IBM MQ page sets. COPYPAGE Expanding a page set (COPYPAGE) on z/OS
Copy IBM MQ page sets and reset the log information. RESETPAGE Copy a page set and resetting the log (RESETPAGE) on z/OS

Purpose Function See topic
Issue IBM MQ commands. COMMAND Use the COMMAND function of CSQUTIL on z/OS
Produce a set of DEFINE, ALTER or DELETE commands for objects. COMMAND Making a list of DEFINE commands
Produce a client channel definition file. COMMAND Making a client channel definition file
Produce a set of DEFINE commands for objects (offline). SDEFS Producing a list of IBM MQ define commands (SDEFS) on z/OS

Purpose Function See topic
Copy contents of a queue to a data set. COPY Copy queues into a data set while the queue manager is running (COPY) on z/OS
Copy contents of a queue to a data set (offline). SCOPY Copy queues into a data set while the queue manager is not running (SCOPY) on z/OS
Delete contents of a queue. EMPTY Emptying a queue of all messages (EMPTY) on z/OS
Restore contents of a queue. LOAD Restoring messages from a data set to a queue (LOAD) on z/OS

Purpose Function See topic
Produce an ALTER QMGR command from a channel initiator parameter module. XPARM Migrating a channel initiator parameter module (XPARM) on z/OS

Purpose Function See topic
Add active or archive log data sets. NEWLOG Adding information about a data set to the BSDS (NEWLOG) on z/OS
Delete active or archive log data sets. DELETE Delete information about a data set from the BSDS (DELETE) on z/OS
Supply passwords for archive logs. ARCHIVE Supplying a password for archive log data sets (ARCHIVE) on z/OS
Control the next restart of the queue manager. CRESTART Control the next restart (CRESTART) on z/OS
Set checkpoint records. CHECKPT Set checkpoint records (CHECKPT) on z/OS
Update the highest written log RBA. HIGHRBA Updating the highest written log RBA (HIGHRBA) on z/OS

Name Purpose See topic
CSQJU004 (Print log map utility) List information about the log. The print log map utility (CSQJU004) on z/OS
CSQ1LOGP (Log print utility) Print the log.

Extract log records into sequential files.

The log print utility (CSQ1LOGP) on z/OS
CSQ5PQSG ( IBM MQ table update utility) Add and remove queue sharing group and queue manager entries in the IBM MQ tables held in the shared Db2 data-sharing group. The queue sharing group utility (CSQ5PQSG) on z/OS
CSQJUFMT (Active log preformat utility) Preformat log data sets

Preformat Shared Message Data Sets (SMDS)

The active log preformat utility (CSQJUFMT) on z/OS
CSQUDLQH (Dead-letter queue handler utility) Process messages on the dead-letter queue. The dead-letter queue handler utility (CSQUDLQH) on z/OS
CSQUCVX (Data conversion exit utility) Generate data conversion exit routines. Writing a data-conversion exit program for IBM MQ for z/OS
CSQUDSPM (Display queue manager utility) Display information about queue managers. The equivalent function on Multiplatforms is dspmq. Display queue manager information utility (CSQUDSPM)

These utilities are located in the thlqual.SCSQAUTH or thlqual.SCSQLOAD IBM MQ load libraries. Concatenate the appropriate IBM MQ language load library thlqual.SCSQANLx (where x is the language letter) in the STEPLIB with the thlqual.SCSQAUTH and thlqual.SCSQLOAD. The utility control statements are available only in U.S. English. In some cases, the Db2 library db2qual.SDSNLOAD is also needed.

Parent topic: Use the IBM MQ utilities on z/OS