MQSC Commands with Syntax

This section describes, in alphabetical order, all the MQSC commands that can be issued by operators and administrators.

• ALTER AUTHINFO
  Use the MQSC command ALTER AUTHINFO to alter an authentication information object.
• ALTER BUFFPOOL
  Use the MQSC command ALTER BUFFPOOL to dynamically change the settings of a predefined buffer pool.
• ALTER CFSTRUCT
  Use the MQSC command ALTER CFSTRUCT to alter the CF application structure backup and recovery parameters, and offload environment parameters for any specified application structure.
• ALTER CHANNEL
  Use the MQSC command ALTER CHANNEL to alter the parameters of a channel.
• ALTER CHANNEL (MQTT)
  Syntax diagram for a telemetry channel when using the ALTER CHANNEL command.
• ALTER COMMINFO
  Use the MQSC command ALTER COMMINFO to alter the parameters of a communication information object.
• ALTER LISTENER
  Use MQSC command ALTER LISTENER to alter the parameters of an existing IBM® MQ listener definition. If the listener is already running, any changes you make to its definition are effective only after the next time that the listener is started.
• ALTER NAMELIST
  Use the MQSC command ALTER NAMELIST to alter a list of names. This list is most commonly a list of cluster names or queue names.
• ALTER PROCESS
  Use the MQSC command ALTER PROCESS to alter the parameters of an existing IBM MQ process definition.

• ALTER PSID
  Use the MQSC command ALTER PSID to change the expansion method for a page set.
• ALTER QMGR
  Use the MQSC command ALTER QMGR to alter the queue manager parameters for the local queue manager.
• ALTER queues
  Use the MQSC ALTER command to alter the parameters of a queue. A queue might be a local queue ( ALTER QLOCAL), alias queue ( ALTER QALIAS ), model queue ( ALTER QMODEL ), a remote queue, a queue-manager alias, or a reply-to queue alias (ALTER QREMOTE ).
• ALTER SECURITY
  Use the MQSC command ALTER SECURITY to define system-wide security options.
• ALTER SERVICE
  Use the MQSC command ALTER SERVICE to alter the parameters of an existing IBM MQ service definition.
• ALTER SMDS
  Use the MQSC command ALTER SMDS to alter the parameters of existing IBM MQ definitions relating to one or more shared message data sets associated with a specific application structure. It is only supported when the CFSTRUCT definition is using the option OFFLOAD(SMDS).
• ALTER STGCLASS
  Use the MQSC command ALTER STGCLASS to alter the characteristics of a storage class.
• ALTER SUB
  Use the MQSC command ALTER SUB to alter the characteristics of an existing subscription.
• ALTER TOPIC
  Use ALTER TOPIC to alter the parameters of an existing IBM MQ topic object.
• ALTER TRACE
  Use the MQSC command ALTER TRACE to change the trace events being traced for a particular active queue manager trace. ALTER TRACE stops the specified trace, and restarts it with the altered parameters.
• ARCHIVE LOG
  Use the MQSC command ARCHIVE LOG as part of your backup procedure. It takes a copy of the current active log (or both logs if you are using dual logging).
• BACKUP CFSTRUCT
  Use the MQSC command BACKUP CFSTRUCT to initiate a CF application structure backup.
• CLEAR QLOCAL
  Use the MQSC command CLEAR QLOCAL to clear the messages from a local queue.
• CLEAR TOPICSTR
  Use the MQSC command CLEAR TOPICSTR to clear the retained message which is stored for the specified topic string.
• DEFINE AUTHINFO
  Use the MQSC command DEFINE AUTHINFO to define an authentication information object. These objects contain the definitions required to perform certificate revocation checking using OCSP or Certificate Revocation Lists (CRLs) on LDAP servers, and the definitions required to enable user ID and password checking.
• DEFINE BUFFPOOL
  Use the MQSC command DEFINE BUFFPOOL to define a buffer pool that is used for holding messages in main storage.
• DEFINE CFSTRUCT
  Use the MQSC command DEFINE CFSTRUCT to define queue manager CF level capability, message offload environment, and backup and recovery parameters for a coupling facility application structure.
• DEFINE CHANNEL
  Use the MQSC command DEFINE CHANNEL to define a new channel, and set its parameters.
• DEFINE CHANNEL (MQTT)
  Syntax diagram for a telemetry channel when using the DEFINE CHANNEL command.
• DEFINE COMMINFO
  Use the MQSC command DEFINE COMMINFO to define a new communication information object. These objects contain the definitions required for Multicast messaging.
• DEFINE LISTENER
  Use the MQSC command DEFINE LISTENER to define a new IBM MQ listener definition, and set its parameters.
• DEFINE LOG
  Use the MQSC command DEFINE LOG to add a new active log data set in the ring of active logs.
• DEFINE MAXSMSGS
  Use the MQSC command DEFINE MAXSMSGS to define the maximum number of messages that a task can get or put within a single unit of recovery.
• DEFINE NAMELIST
  Use the MQSC command DEFINE NAMELIST to define a list of names. This is most commonly a list of cluster names or queue names.
• DEFINE PROCESS
  Use the MQSC command DEFINE PROCESS to define a new IBM MQ, process definition, and set its parameters.
• DEFINE PSID
  Use the MQSC command DEFINE PSID to define a page set and associated buffer pool.
• DEFINE queues
  Use the MQSC DEFINE command to define a local, model, or remote queue, or a queue alias, reply-to queue alias, or a queue-manager alias.
• DEFINE SERVICE
  Use the MQSC command DEFINE SERVICE to define a new IBM MQ service definition, and set its parameters.
• DEFINE STGCLASS
  Use the MQSC command DEFINE STGCLASS to define a storage class to page set mapping.
• DEFINE SUB
  Use DEFINE SUB to allow an existing application to participate in a publish/subscribe application by allowing the administrative creation of a durable subscription.
• DEFINE TOPIC
  Use DEFINE TOPIC to define a new IBM MQ administrative topic in a topic tree, and set its parameters.
• DELETE AUTHINFO
  Use MQSC command DELETE AUTHINFO to delete an authentication information object.
• DELETE AUTHREC
  Use the MQSC command DELETE AUTHREC to delete authority records associated with a profile name.
• DELETE BUFFPOOL
  Use the MQSC command DELETE BUFFPOOL to delete a buffer pool that is used for holding messages in main storage.
• DELETE CFSTRUCT
  Use the MQSC command DELETE CFSTRUCT to delete a CF application structure definition.
• DELETE CHANNEL
  Use the MQSC command DELETE CHANNEL to delete a channel definition.
• DELETE CHANNEL (MQTT)
  Use the MQSC command DELETE CHANNEL to delete an IBM MQ Telemetry channel definition.
• DELETE COMMINFO
  Use the MQSC command DELETE COMMINFO to delete a communication information object.
• DELETE LISTENER
  Use the MQSC command DELETE LISTENER to delete a listener definition.
• DELETE NAMELIST
  Use the MQSC command DELETE NAMELIST to delete a namelist definition.
• DELETE POLICY
  Use the MQSC command DELETE POLICY to delete a security policy.
• DELETE PROCESS
  Use the MQSC command DELETE PROCESS to delete a process definition.
• DELETE PSID
  Use the MQSC command DELETE PSID to delete a page set. This command closes the page set and de-allocates it from the queue manager.
• DELETE queues
• DELETE SERVICE
  Use the MQSC command DELETE SERVICE to delete a service definition.
• DELETE SUB
  Use the MQSC command DELETE SUB to remove a durable subscription from the system. For a managed destination, any unprocessed messages left on the destination are removed.
• DELETE STGCLASS
  Use the MQSC command DELETE STGCLASS to delete a storage class definition.
• DELETE TOPIC
  Use DELETE TOPIC to delete an IBM MQ administrative topic node.
• DISPLAY ARCHIVE
  Use the MQSC command DISPLAY ARCHIVE to display archive system parameters and information.
• DISPLAY AUTHINFO
  Use the MQSC command DISPLAY AUTHINFO to display the attributes of an authentication information object.
• DISPLAY AUTHREC
  Use the MQSC command DISPLAY AUTHREC to display the authority records associated with a profile name.
• DISPLAY AUTHSERV
  Use the MQSC command DISPLAY AUTHSERV to display information about the level of function supported by the installed authorization services.
• DISPLAY CFSTATUS
  Use the MQSC command DISPLAY CFSTATUS to display the status of one or more CF application structures. This command is valid only on IBM MQ for z/OS® when the queue manager is a member of a queue-sharing group.
• DISPLAY CFSTRUCT
  Use the MQSC command DISPLAY CFSTRUCT to display the attributes of one or more CF application structures. This command is valid only on z/OS when the queue manager is a member of a queue-sharing group.
• DISPLAY CHANNEL
  Use the MQSC command DISPLAY CHANNEL to display a channel definition.
• DISPLAY CHANNEL (MQTT)
  Use the MQSC command DISPLAY CHANNEL (MQTT) to display an IBM MQ Telemetry channel definition.
• DISPLAY CHINIT
  Use the MQSC command DISPLAY CHINIT to display information about the channel initiator. The command server must be running.
• DISPLAY CHLAUTH
  Use the MQSC command DISPLAY CHLAUTH to display the attributes of a channel authentication record.
• DISPLAY CHSTATUS
  Use the MQSC command DISPLAY CHSTATUS to display the status of one or more channels.
• DISPLAY CHSTATUS (AMQP)
  Use the MQSC command DISPLAY CHSTATUS (AMQP) to display the status of one or more AMQP channels.
• DISPLAY CHSTATUS (MQTT)
  Use the MQSC command DISPLAY CHSTATUS (MQTT) to display the status of one or more IBM MQ Telemetrychannels.
• DISPLAY CLUSQMGR
  Use the MQSC command DISPLAY CLUSQMGR to display information about cluster channels for queue managers in a cluster.
• DISPLAY CMDSERV
  Use the MQSC command DISPLAY CMDSERV to display the status of the command server.
• DISPLAY COMMINFO
  Use the MQSC command DISPLAY COMMINFO to display the attributes of a communication information object.
• DISPLAY CONN
  Use the MQSC command DISPLAY CONN to display connection information about the applications connected to the queue manager. This is a useful command because it enables you to identify applications with long-running units of work.
• DISPLAY ENTAUTH
  Use the MQSC command DISPLAY ENTAUTH to display the authorizations an entity has to a specified object.
• DISPLAY GROUP
  Use the MQSC command DISPLAY GROUP to display information about the queue-sharing group to which the queue manager is connected. This command is valid only when the queue manager is a member of a queue-sharing group.
• DISPLAY LISTENER
  Use the MQSC command DISPLAY LISTENER to display information about a listener.
• DISPLAY LOG
  Use the MQSC command DISPLAY LOG to display log system parameters and information.
• DISPLAY LSSTATUS
  Use the MQSC command DISPLAY LSSTATUS to display status information for one or more listeners.
• DISPLAY MAXSMSGS
  Use the MQSC command DISPLAY MAXSMSGS to see the maximum number of messages that a task can get or put within a single unit of recovery.
• DISPLAY NAMELIST
  Use the MQSC command DISPLAY NAMELIST to display the names in a namelist.
• DISPLAY POLICY
  Use the MQSC command DISPLAY POLICY to display a security policy.
• DISPLAY PROCESS
  Use the MQSC command DISPLAY PROCESS to display the attributes of one or more IBM MQ processes.
• DISPLAY PUBSUB
  Use the MQSC command DISPLAY PUBSUB to display publish/subscribe status information for a queue manager.
• DISPLAY QMGR
  Use the MQSC command DISPLAY QMGR to display the queue manager parameters for this queue manager.
• DISPLAY QMSTATUS
  Use the MQSC command DISPLAY QMSTATUS to display status information associated with this queue manager.
• DISPLAY QSTATUS
  Use the MQSC command DISPLAY QSTATUS to display the status of one or more queues.
• DISPLAY QUEUE
  Use the MQSC command DISPLAY QUEUE to display the attributes of one or more queues of any type.
• DISPLAY SBSTATUS
  Use the MQSC command DISPLAY SBSTATUS to display the status of a subscription.
• DISPLAY SECURITY
  Use the MQSC command DISPLAY SECURITY to display the current settings for the security parameters.
• DISPLAY SERVICE
  Use the MQSC command DISPLAY SERVICE to display information about a service.
• DISPLAY SMDS
  Use the MQSC command DISPLAY SMDS to display the parameters of existing IBM MQ shared message data sets associated with a specified application structure.
• DISPLAY SMDSCONN
  Use the MQSC command DISPLAY SMDSCONN to display status and availability information about the connection between the queue manager and the shared message data sets for the specified CFSTRUCT.
• DISPLAY STGCLASS
  Use the MQSC command DISPLAY STGCLASS to display information about storage classes.
• DISPLAY SUB
  Use the MQSC command DISPLAY SUB to display the attributes associated with a subscription.
• DISPLAY SVSTATUS
  Use the MQSC command DISPLAY SVSTATUS to display status information for one or more services. Only services with aSERVTYPE of SERVER are displayed.
• DISPLAY SYSTEM
  Use the MQSC command DISPLAY SYSTEM to display general system parameters and information.
• DISPLAY TCLUSTER
  Use the MQSC command DISPLAY TCLUSTER to display the attributes of the IBM MQ cluster topic object.
• DISPLAY THREAD
  Use the MQSC command DISPLAY THREAD to display information about active and in-doubt threads.
• DISPLAY TOPIC
  Use the MQSC command DISPLAY TOPIC to display the attributes of one or more IBM MQ topic objects of any type.
• DISPLAY TPSTATUS
  Use the MQSC command DISPLAY TPSTATUS to display the status of one or more topics in a topic tree.
• DISPLAY TRACE
  Use the MQSC command DISPLAY TRACE to display a list of active traces.
• DISPLAY USAGE
  Use the MQSC command DISPLAY USAGE to display information about the current state of a page set, to display information about the log data sets, or to display information about the shared message data sets.
• MOVE QLOCAL
  Use the MQSC command MOVE QLOCAL to move all the messages from one local queue to another.
• PING CHANNEL
  Use the MQSC command PING CHANNEL to test a channel by sending data as a special message to the remote queue manager, and checking that the data is returned. The data is generated by the local queue manager.
• PING QMGR
  Use the MQSC command PING QMGR to test whether the queue manager is responsive to commands.
• PURGE CHANNEL
  Use the MQSC command PURGE CHANNEL to stop and purge a telemetry or AMQP channel. Purging a telemetry or AMQP channel disconnects all the MQTT or AMQP clients connected to it, cleans up the state of theMQTT or AMQP clients, and stops the telemetry or AMQP channel. Cleaning the state of a client deletes all the pending publications and removes all the subscriptions from the client.
• RECOVER CFSTRUCT
  Use the MQSC command RECOVER CFSTRUCT to initiate recovery of CF application structures and associated shared message data sets. This command is valid only when the queue manager is a member of a queue-sharing group.
• REFRESH CLUSTER
  Use the MQSC command REFRESH CLUSTER to discard all locally held cluster information and force it to be rebuilt. The command also processes any autodefined channels that are in doubt. After the command completes processing, you can perform a cold-start on the cluster.
• REFRESH QMGR
  Use the MQSC command REFRESH QMGR to perform special operations on queue managers.
• REFRESH SECURITY
  Use the MQSC command REFRESH SECURITY to perform a security refresh.
• RESET CFSTRUCT
  Use the MQSC command RESET CFSTRUCT to modify the status of a specific application structure.
• RESET CHANNEL
  Use the MQSC command RESET CHANNEL to reset the message sequence number for an IBM MQ channel with, optionally, a specified sequence number to be used the next time that the channel is started.
• RESET CLUSTER
  Use the MQSC command RESET CLUSTER to perform special operations on clusters.
• RESET QMGR
  Use the MQSC command RESET QMGR as part of your backup and recovery procedures.
• RESET QSTATS
  Use the MQSC command RESET QSTATS to report performance data for a queue and then to reset that data.
• RESET SMDS
  Use the MQSC command RESET SMDS to modify availability or status information relating to one or more shared message data sets associated with a specific application structure.
• RESET TPIPE
  Use the MQSC command RESET TPIPE to reset the recoverable sequence numbers for an IMS™ Tpipe used by theIBM MQ –IMS bridge.
• RESOLVE CHANNEL
  Use the MQSC command RESOLVE CHANNEL to request a channel to commit or back out in-doubt messages.
• RESOLVE INDOUBT
  Use the MQSC command RESOLVE INDOUBT to resolve threads left in doubt because IBM MQ or a transaction manager could not resolve them automatically.
• RESUME QMGR
  Use the MQSC command RESUME QMGR to inform other queue managers in a cluster that the local queue manager is available again for processing and can be sent messages. It reverses the action of the SUSPEND QMGR command.
• RVERIFY SECURITY
  Use the MQSC command RVERIFY SECURITY to set a reverification flag for all specified users. The user is reverified the next time that security is checked for that user.
• SET ARCHIVE
  Use the MQSC command SET ARCHIVE to dynamically change certain archive system parameter values initially set by your system parameter module at queue manager startup.
• SET AUTHREC
  Use the MQSC command SET AUTHREC to set authority records associated with a profile name.
• SET CHLAUTH
  Use the MQSC command SET CHLAUTH to create or modify a channel authentication record.
• SET LOG
  Use the MQSC command SET LOG to dynamically change certain log system parameter values that were initially set by your system parameter module at queue manager startup.
• SET POLICY
  Use the MQSC command SET POLICY to set a security policy.
• SET SYSTEM
  Use the MQSC command SET SYSTEM to dynamically change certain general system parameter values that were initially set from your system parameter module at queue manager startup. To permanently change these, either change the CSQ6SYSP parameters and regenerate the parameter module, or put the SET SYSTEM commands into a data set in the CSQINP2 concatenation.
• START CHANNEL
  Use the MQSC command START CHANNEL to start a channel.
• START CHANNEL (MQTT)
  Use the MQSC command START CHANNEL to start an IBM MQ Telemetry channel.
• START CHINIT
  Use the MQSC command START CHINIT to start a channel initiator.
• START CMDSERV
  Use the MQSC command START CMDSERV to initialize the command server.
• START LISTENER
  Use the MQSC command START LISTENER to start a channel listener.
• START QMGR
  Use the MQSC command START QMGR to initialize the queue manager.
• START SERVICE
  Use the MQSC command START SERVICE to start a service. The identified service definition is started within the queue manager and inherits the environment and security variables of the queue manager.
• START SMDSCONN
  Use the MQSC command START SMDSCONN to enable a previously stopped connection from this queue manager to the specified shared message data sets, allowing them to be allocated and opened again.
• START TRACE
  Use the MQSC command START TRACE to start traces.
• STOP CHANNEL
  Use the MQSC command STOP CHANNEL to stop a channel.
• STOP CHANNEL (MQTT)
  Use the MQSC command STOP CHANNEL to stop an IBM MQ Telemetry channel.
• STOP CHINIT
  Use the MQSC command STOP CHINIT to stop a channel initiator. The command server must be running.
• STOP CMDSERV
  Use the MQSC command STOP CMDSERV to stop the command server.
• STOP CONN
  Use the MQSC command STOP CONN to break a connection between an application and the queue manager.
• STOP LISTENER
  Use the MQSC command STOP LISTENER to stop a channel listener.
• STOP QMGR
  Use the MQSC command STOP QMGR to stop the queue manager.
• STOP SERVICE
  Use the MQSC command STOP SERVICE to stop a service.
• STOP SMDSCONN
  Use the MQSC command STOP SMDSCONN to terminate the connection from this queue manager to one or more specified shared message data sets (causing them to be closed and deallocated) and to mark the connection as STOPPED.
• STOP TRACE
  Use the MQSC command STOP TRACE to stop tracing.
• SUSPEND QMGR
  Use the MQSC command SUSPEND QMGR to advise other queue managers in a cluster to avoid sending messages to the local queue manager if possible.