IBM MQ utility program (CSQUTIL) on z/OS

The CSQUTIL utility program is provided with IBM MQ to help you to perform backup, restoration, and reorganization tasks, and to issue IBM MQ commands.

Through this utility program, we can invoke functions in these groups:

Page set management

These functions enable you to manage IBM MQ page sets. We can format data sets as page sets, change the recovery processing performed against page sets, extract page set information, increase the size of page sets and reset the log information contained in a page set. The page set must not belong to a queue manager that is currently running.

Command management

These functions enable you to:

• Issue commands to IBM MQ
• Produce a list of DEFINE, ALTER, or DELETE commands for the IBM MQ objects

Queue management

These functions enable you to back up and restore queues and page sets, copy queues and page sets to another queue manager, reset your queue manager, or to migrate from one queue manager to another. Specifically, we can:

• Copy messages from a queue to a data set
• Delete messages from a queue
• Restore previously copied messages to their appropriate queues

The scope of these functions can be either:

• A queue, in which case the function operates on all messages in the specified queue.
• A page set, in which case the function operates on all the messages, in all the queues, on the specified page set.

Use these functions only for the own queues; do not use them for system queues (those with names beginning SYSTEM).

All the page set management functions, and some of the other functions, operate while the queue manager is not running, so we do not need any special authorization other than the appropriate access to the page set data sets. For the functions that operate while the queue manager is running, CSQUTIL runs as an ordinary z/OS batch IBM MQ program, issuing commands through the command server, and using the IBM MQ API to access queues.

You need the necessary authority to use the command server queues (SYSTEM.COMMAND.INPUT, SYSTEM.COMMAND.REPLY.MODEL, and SYSTEM.CSQUTIL.*), to use the IBM MQ DISPLAY commands, and to use the IBM MQ API to access any queues that we want to manage. See the usage notes for each function for more information.

Attention: If we use CSQUTIL to define a channel, and the connection name contains two parts (the host name and port number) we must enclose the host name and port number within single quotation marks to maintain the limit on the number of permissible parameters. Similarly, if your connection name consists of an IP address and port number, we must enclose these parameters within single quotation marks.

• Invoking the IBM MQ utility program on z/OS
  Use this topic to understand how to invoke CSQUTIL, the format of its parameters, and its return codes.
• Monitor the progress of the IBM MQ utility program on z/OS
  We can monitor the progress of the CSQUTIL program by monitoring statements output to SYSPRINT.
• Formatting page sets (FORMAT) on z/OS
  We can use the CSQUTIL program to format page sets.
• Page set information (PAGEINFO) on z/OS
  Use the PAGEINFO function to extract page set information from one or more page sets, specified by DDnames in the range CSQP0000 through CSQP0099, for the source data sets from which page set information is required.
• Expanding a page set (COPYPAGE) on z/OS
  Use the COPYPAGE function to copy one or more page sets to a larger page set.
• Copy a page set and resetting the log (RESETPAGE) on z/OS
  The RESETPAGE function is like the COPYPAGE function except that it also resets the log information in the new page sets.
• Use the COMMAND function of CSQUTIL on z/OS
  We can use the COMMAND function of CSQUTIL to direct commands to the queue manager.
• Producing a list of IBM MQ define commands (SDEFS) on z/OS
  We can use the SDEFS function of CSQUTIL to produce a list of DEFINE commands describing the objects in your queue manager or queue sharing group.
• Copy queues into a data set while the queue manager is running (COPY) on z/OS
  We can use the COPY function of CSQUTIL to copy queued messages to a sequential data set while the queue manager is running, without destroying any messages in the original queues.
• Copy queues into a data set while the queue manager is not running (SCOPY) on z/OS
  We can use the SCOPY function of CSQUTIL to copy queued messages to a sequential data set when the queue manager is not running, without destroying any messages in the original queues.
• Analyzing the queue data copied to a data set by COPY or SCOPY using ANALYZE on z/OS
  Use this topic to understand analyzing the queue data copied to a data set by COPY or SCOPY.
• Emptying a queue of all messages (EMPTY) on z/OS
  We can use the EMPTY function of CSQUTIL to delete all messages from a named queue or all the queues on a page set.
• Restoring messages from a data set to a queue (LOAD) on z/OS
  The LOAD function of CSQUTIL is complementary to the COPY or SCOPY function. LOAD restores messages from the destination data set of an earlier COPY or SCOPY operation. The queue manager must be running.
• Restoring messages from a data set to a queue (SLOAD) on z/OS
  The SLOAD function of CSQUTIL is complementary to the COPY or SCOPY function. SLOAD restores messages from the destination data set of an earlier COPY or SCOPY operation. SLOAD processes a single queue.
• Migrating a channel initiator parameter module (XPARM) on z/OS
  We can use the XPARM function of CSQUTIL to generate ALTER QMGR command that can be used to migrate to Version 7.0.
• Switch the transmission queue associated with cluster-sender channels (SWITCH)
  We can use the SWITCH function of CSQUTIL to switch or query the transmission queue associated with cluster-sender channels.

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