mqsideploy command

Supported platforms

  • Windows 2000, Windows XP

Purpose

Use the mqsideploy command to make a deploy request to the Configuration Manager. This allows you to make the various flavors of deploy requests from a batch command script, without the need for manual interaction.

The default situation is a delta or incremental deploy. Select -complete to override the default operation.

The return code from mqsideploy is zero if the command succeeds. If the command fails, the return code is theBIP message number that describes the failure, minus 1000 for messages in the format BIP1xxx; or minus 8000, for messages in the format BIP8xxx. For example, if the command fails with the message BIP1034, the return code is 34.

Syntax

Parameters

Start of change-b BrokernameEnd of change
Start of change(Optional) The name of the broker to which to deploy. If any of the -topics, -topology, or -cancel flags are specified, the -b option is ignored. This is because, when deploying topics or topology, or when cancelling an in-progress deployment, all brokers in the domain are affected. Without the -e and -bar flags, a broker configuration deploy is initiated.End of change
-e EGName
(Optional) The name of the execution group to which to deploy. The -b and -bar options must also be specified with this option.
-bar BARFile
(Optional) The name of the BAR (Broker Archive) file that is to be used for a message flow or message set deploy. The -b and -e options must also be specified with this option.
-topics
(Optional) Deploy all the topics configuration information. Information is deployed to all brokers in the domain.
-topology
(Optional) This flag specifies that the Topology configuration should be deployed. Information is deployed to all brokers in the domain if the -complete flag is also set, otherwise the information is deployed only to brokers with a changed topology configuration.
-cancel
(Optional) Cancel any outstanding deploys, that is, brokers that have not replied to previous deploy requests (cancel deploy). All other flags except -w and -r are ignored when this option is used.
-r
(Optional) Read and display log records associated with the previous deploy request. Use this in conjunction with the -w option to wait for a specified amount of time. Once a log record has been read, the deploy is considered complete and the log record, or records, associated with it are deleted.
-w timeoutValue
(Optional) The time in seconds that the utility waits for the broker to reply before returning control to the command line. The mqsideploy command polls the Configuration Manager log records looking for the results of the deploy request that has just been sent. The relevant log records contain information indicating whether the deploy has been successful. The timeoutValue is the number of seconds to wait before timing out, in the range 1 - 999 999. If no timeoutValue is provided, or a value less than 1 or greater than 999 999 is specified, an error is returned
- connection connectionParametersFile
(Optional) The name of a .configmgr file that describes the connection parameters to the Configuration Manager. The file is in XML, using the .configmgr format saved by the Eclipse GUI. For example:
<?xml version="1.0" encoding="UTF-8"?>
<configmgr host="localhost" listenerPort="1414" queueManager="LUCAS" 
           securityExit="test.myExit"/>
If you omit the -connection option, the command gets the configuration information from a file in the utility's working directory called mqsicfgutil.ini. This file has the format:
hostname = localhost
queueManager = QMNAME
port = 1414
securityExit = test.myExit

Specifying the -connection option causes the mqsicfgutil.ini file to be ignored.

These files need to be in the directory from which the command is being run. This is not necessarily the same directory as the mqsideploy.bat file.

-rmMsgFlow name
(Optional) Removes the named message flow from the supplied execution group. This change is deployed to the broker immediately.
-rmMsgSet name
(Optional) Removes the named message set from the supplied execution group. This change is deployed to the broker immediately.
-complete
(Optional) Deploy complete information:
  • For a BAR file deploy, -complete removes all currently-deployed message flows and message sets from the execution group as part of the deploy. If -complete is not set, the contents of the BAR file are deployed in addition to what is already deployed on the execution group. In this case, any deployed objects with the same name as an item inside the BAR are replaced by the version inside the BAR.
  • For a topology configuration deploy, -complete deploys complete interbroker configuration information to all brokers. If -complete is not set, only changed interbroker configuration is deployed to brokers whose interbroker configuration has changed.
  • For a broker deploy, -complete deploys all the broker's available configuration attributes to the specified broker, for example, multicast parameters. If -complete is not set, only changed configuration attributes are deployed.
  • For a topic tree deploy, -complete deploys the entire topic tree to all brokers. If -complete is not set, only changes to the topic tree are deployed to all brokers.
  • For a remove message flow or remove message set operation, the flag is ignored.

Examples

Perform a deploy to broker <broker_name> and wait five minutes for a reply:

mqsideploy -b <broker_name> -w 300

Read any replies (log messages) received from brokers that have previously been deployed to:

mqsideploy -r
Related concepts
Runtime environment
Related reference
Syntax preference