WebSphere Message Brokers
File: an28530_
Writer: Bill Oppenheimer

Reference topic

This build: July 31, 2007 21:34:32

mqsideploy command - z/OS

BIPDPLY is used to run mqsideploy, and on z/OS the command does this from JAVA bindings; see Usage note.

Syntax

z/OS command - BIPDPLY

z/OS console command

Synonym: dp

Parameters

-n CfgParameterFileName
(Optional) This parameter specifies the name of a .configmgr file that describes the connection parameters to the Configuration Manager.
Remove the statement encoding="UTF-8" from the first line of the .configmgr file, and remove the value for the host attribute, to leave the statement as:
<?xml version="1.0"?>
<configmgr crlNameList="" domainName="" host="" listenerPort="2206" 
queueManager="mq06" securityExit="" securityExitJar="" sslCipherSuite="NONE" 
sslDistinguishedNames="" sslKeyStore="" sslTrustStore="" svrconn="SYSTEM.BKR.CONFIG"/>
-i IpAddress
(Optional) This parameter specifies the host name or IP address of the Configuration Manager.

To connect to the local host, set the value to a space (" ").

-p Port
(Optional) This parameter is the port number of the Configuration Manager.
-q QMgr
(Optional) This parameter specifies the name of the WebSphere MQ queue manager that the Configuration Manager is using.

If you do not supply the -i, -p, and -q parameters, you must specify the -n parameter.

-b Brokername
(Optional) This parameter specifies the name of the broker to which to deploy. If you specify either of the -t or -l parameters, the -b parameter is ignored because, when deploying topics or topology, all brokers in the domain are affected. Without the -e and -a parameters, a broker configuration deployment is initiated. If you do not specify the -b parameter, the command applies to all brokers in the domain.
Specify the -c parameter to cancel deployment to a specific broker.
-e EGName
(Optional) This parameter specifies the name of the execution group to which to deploy. You must specify -b and -a with this parameter.
-a BARFileName
(Optional) This parameter specifies the name of the bar (broker archive) file that is to be used for message flow or message set deployment. You must also specify the -b and -e parameters with this option.

The bar file must be in the file system. The bar file can be anywhere in the file system, as long as the user ID of the person or Configuration Manager that is running the command can access the file and read it.

-t
(Optional) This parameter specifies deployment of all the topics configuration information.
  • When used in conjunction with the -m parameter, the -t parameter causes the complete topics hierarchy to be deployed to all brokers in the domain.
  • When used without the -m parameter, the -t parameter causes only changes to the topics hierarchy (since the last successful topics deployment) to be deployed to all brokers in the domain.
-l
(Optional) This parameter specifies that the topology configuration should be deployed. Information is deployed to all brokers in the domain if the -m parameter is also set; otherwise, the information is deployed only to brokers with a changed topology configuration.
-c
(Optional) This parameter instructs the Configuration Manager to stop waiting for responses to previously submitted deployment requests. If used with the -b parameter, the Configuration Manager stops waiting for outstanding deployment responses from the specified broker; without the -b parameter, the Configuration Manager stops waiting for responses to all outstanding deployment requests in the domain.

Specify the -c parameter with caution; it has the effect of canceling deployment requests. Use this option only if there is no possibility that the affected brokers will respond to the outstanding requests. If a broker subsequently processes a deployment request that has been cancelled, the Configuration Manager ignores the response, and is therefore no longer synchronized with the broker.

-w TimeoutValue
(Optional) This parameter specifies 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 deployment request that has just been sent. The relevant log records contain information indicating whether the deployment was 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
-d DeployedObjects
(Optional) This parameter describes the set of objects that you want to remove from the execution group. You can specify multiple files to deploy by separating the filenames with a colon (:).

You can specify objects of all types, but if you specify an ambiguous object name (for example, "top", when both "top.dictionary" and "top.cmf" are deployed to the same execution group), the entire command fails with the message BIP1089. In these circumstances, you must specify the fully qualified name of the objects to remove; for example, "top.dictionary:top.cmf".

-v TraceFileName
(Optional) This parameter sends the internal Configuration Manager Proxy trace to the specified file.
-m
(Optional) This parameter specifies deployment of complete information:
  • For a bar file deployment, -m removes all currently-deployed message flows and message sets from the execution group as part of the deployment. If -m is not set, the contents of the bar file are deployed in addition to what is already deployed to the execution group. Any deployed objects with the same name as an item inside the bar file are replaced by the version inside the bar file.
  • For a topology configuration deployment, -m deploys complete inter-broker configuration information to all brokers. If -m is not set, only changed inter-broker configuration is deployed to brokers whose inter-broker configuration has changed.
  • For a broker configuration deployment this parameter is not valid.
  • For a topic tree deployment, -m deploys the entire topic tree to all brokers. If -m 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 -m parameter is ignored.

Usage note

If you enter:
mqsideploy -i cm_name -p port -q cm_qm -l  -m 
the command attempts to run the mqsideploy command using WebSphere MQ Java client code, which is not allowed on z/OS. Connecting to the local Configuration Manager with the parameters -i and -p forces the command into a local mode, and the following error occurs:
BIP1046E: Unable to connect with the Configuration Manager's queue manager
Depending on the version of WebSphere MQ that you are using, the reported reason codes differ:
  • On WebSphere MQ V5.3.1, you receive:
    2012 0x000007dc MQRC_ENVIRONMENT_ERROR
  • On WebSphere MQ V6.0, you receive:
    2298 0x000008fa MQRC_FUNCTION_NOT_SUPPORTED

Examples

Deploy publish/subscribe neighbors using a connection file whose parameters are described in the file cm1.configmgr, allow 10 minutes for the broker to reply, and deploy complete inter-broker configuration information:
  mqsideploy -n cm1.configmgr -m -w 600 
Deploy publish/subscribe neighbors using the i, p, and q parameters to connect to the Configuration Manager, allow 10 minutes for the broker to reply, and deploy complete inter-broker configuration information:
  mqsideploy -i localhost -p 1414 -q QMNAME -m -w 600 

Note that you can use the i, p, and q parameters in the following examples instead of the -n parameter.

Deploy a topics hierarchy using a connection file whose parameters are described in the file cm1.configmgr, allow 10 minutes for the broker to reply, and deploy complete inter-broker configuration information:
  mqsideploy -n cm1.configmgr -t -m -w 600 
Deploy a bar file using a connection file whose parameters are described in the file cm1.configmgr, to the specified broker, allow 10 minutes for the broker to reply, and remove all currently-deployed message flows and message sets from the execution group as part of the deployment:
  mqsideploy -n cm1.configmgr -b broker1 -e default -a mybar.bar -m -w 600 
Deploy a broker configuration using a connection file whose parameters are described in the file cm1.configmgr, to the specified broker, and allow 15 minutes for the broker to reply:
  mqsideploy -n cm1.configmgr -b broker1 -w 900 
Attempt to remove the message flow top and the dictionary bar from the execution group default on broker b1, using a connection file whose parameters are described in the file cm1.configmgr. (If there are no other objects called top and bar deployed to the execution group, you can shorten the value of the -d parameter to top:bar).
  mqsideploy –n cm1.configmgr –b B1 –e default –d top.cmf:bar.dictionary
Cancel a deployment using a connection file whose parameters are described in the file cm1.configmgr, and allow 15 minutes for the broker to reply. In this example, the Configuration Manager stops waiting for all outstanding deployment requests in the domain.
  mqsideploy -n cm1.configmgr -c -w 900 
Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2007Copyright IBM Corporation 1999, 2007. All Rights Reserved.
This build: July 31, 2007 21:34:32

an28530_ This topic's URL is: