endmqm (end queue manager)

Stop a queue manager or switch to a standby queue manager.

Purpose

• Controlled or quiesced shutdown
• Immediate shutdown
• Pre-emptive shut down
• Wait shutdown

The endmqm command stops all instances of a multi-instance queue manager in the same way as it stops a single instance queue manager. We can issue the endmqm on either the active instance, or one of the standby instances of a multi-instance queue manager. We must issue endmqm on the active instance to end the queue manager.

If we issue the endmqm command on the active instance of a multi-instance queue manager, we can permit a standby instance to switch over to being the new active instance when the current active instance completes its shutdown.

If we issue the endmqm command on a standby instance of a multi-instance queue manager, we can end the standby instance by adding the -x option, and leave the active instance running. The queue manager reports an error if we issue endmqm on the standby instance without the -x option.

Issuing the endmqm command will affect any client application connected through a server-connection channel. The effect varies depending on the parameter used, but it is as though a STOP CHANNEL command was issued in one of the three possible modes. See Stopping MQI channels, for information about the effects of STOP CHANNEL modes on server-connection channels. The endmqm optional parameter descriptions state which STOP CHANNEL mode they will be equivalent to.

We must use the endmqm command from the installation associated with the queue manager that we are working with. We can find out which installation a queue manager is associated with using the dspmq -o installation command.

The attributes of the queue manager and the objects associated with it are not affected by the endmqm command. We can restart the queue manager using the strmqm (Start queue manager) command.

To delete a queue manager, stop it and then use the dltmqm (Delete queue manager) command.

Syntax

Required parameters

QMgrName

The name of the message queue manager to be stopped.

Optional parameters

-c

Controlled (or quiesced) shutdown. This parameter is the default.

The queue manager stops, but only after all applications have disconnected. Any MQI calls currently being processed are completed. In the unlikely event that a dspmq (display queue managers) command is issued in the small timeframe between the applications disconnecting and the queue manager actually stopping, the dspmq (display queue managers) command might transiently report the status as Ending immediately, even though a controlled shutdown was requested.

Control is returned to you immediately and we are not notified of when the queue manager has stopped.

The effect on any client applications connected through a server-connection channel is equivalent to a STOP CHANNEL command issued in QUIESCE mode.

-i

Immediate shutdown. The queue manager stops after it has completed all the MQI calls currently being processed. Any MQI requests issued after the command has been issued fail. Any incomplete units of work are rolled back when the queue manager is next started.

Control is returned after the queue manager has ended.

The effect on any client applications connected through a server-connection channel is equivalent to a STOP CHANNEL command issued in FORCE mode.

-p

Pre-emptive shutdown. Important: Use this type of shutdown only in exceptional circumstances, for example, when a queue manager does not stop as a result of a normal endmqm command.

The queue manager might stop without waiting for applications to disconnect or for MQI calls to complete. This can give unpredictable results for IBM MQ applications. The shutdown mode is set to immediate shutdown. If the queue manager has not stopped after a few seconds, the shutdown mode is escalated, and all remaining queue manager processes are stopped.

The effect on any client applications connected through a server-connection channel is equivalent to a STOP CHANNEL command issued in TERMINATE mode.

-r

Start trying to reconnect reconnectable clients. This parameter has the effect of reestablishing the connectivity of clients to other queue managers in their queue manager group.

-s

For a multi-instance queue manager, switch over to a standby queue manager instance after shutting down. The command checks that there is a standby instance running before ending the active instance. It does not wait for the standby instance to start before ending. Connections to the queue manager are broken by the active instance shutting down. Reconnectable clients start trying to reconnect. We can configure the reconnection options of a client to reconnect only to another instance of the same queue manager, or to reconnect to other queue managers in the queue manager group.

-w

Wait shutdown.

This type of shutdown is equivalent to a controlled shutdown except that control is returned to you only after the queue manager has stopped. You receive the message Waiting for queue manager qmName to end while shutdown progresses. In the unlikely event that a dspmq (display queue managers) command is issued in the small timeframe between the applications disconnecting and the queue manager actually stopping, the dspmq (display queue managers) command might transiently report the status as Ending immediately, even though a controlled shutdown was requested.

The effect on any client applications connected through a server-connection channel is equivalent to a STOP CHANNEL command issued in QUIESCE mode.

-x

For a multi-instance queue manager, end a standby instance of the queue manager, without ending the active instance of the queue manager.

-z

Suppresses error messages on the command.

-t <interval>

The target time in which ending the queue manager within <interval> seconds is attempted, escalating the phases of application disconnection. Essential queue manager maintenance tasks are allowed to complete, which might prolong the phase of the queue manager ending.

-tp <interval>

The target time in which ending the queue manager within <interval> seconds is attempted, escalating the phases of application disconnection. Essential queue manager maintenance tasks are interrupted if necessary.

These maintenance tasks include the attempt to retain non-persistent messages, when NPMCLASS is set to HIGH on a queue.

Return codes

Examples

1. This command ends the queue manager named mercury.queue.manager in a controlled way. All applications currently connected are allowed to disconnect.

   endmqm mercury.queue.manager
   

2. This command ends the queue manager named saturn.queue.manager immediately. All current MQI calls complete, but no new ones are allowed.

   endmqm -i saturn.queue.manager
   

The results of issuing endmqm to the local instance of a multi-instance queue manager are shown in Table 2. The results of the command depend on whether the -s or -x switch is used, and the running status of local and remote instances of the queue manager.

Related reference

• crtmqm (create queue manager)
• endmqm (end queue manager)
• dltmqm (delete queue manager)

Related information

• Stopping a queue manager
• Stopping a queue manager manually
• Applying maintenance level updates to multi-instance queue managers on Windows
• Applying maintenance level updates to multi-instance queue managers on UNIX and Linux