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

Start of change -n cfgParameterFileNameEnd of change
Start of change(Optional) The name of a .configmgr file that describes the connection parameters to the Configuration Manager. End of change
Start of change
The file is in XML, using the .configmgr format saved by the workbench. For example:
<?xml version="1.0" encoding="UTF-8"?>
<configmgr crlNameList="" domainName="" host="winmvsd0" listenerPort="2206" 
queueManager="mq06" securityExit="" securityExitJar="" sslCipherSuite="NONE" 
sslDistinguishedNames="" sslKeyStore="" sslTrustStore="" svrconn="SYSTEM.BKR.CONFIG"/>
End of change
Start of change
You must remove the statement encoding="UTF-8" from the first line, 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"/>
End of change
-i ipAddress
(Optional) The host name or IP address of the Configuration Manager.

If you want to connect to the local host, you must set the value to " ".

-p Port
(Optional) The port number of the Configuration Manager.
-q qMgr
(Optional) 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) The name of the broker to which to deploy. If either of the -t or -l, options are specified, the -b option is ignored. This is because, when deploying topics or topology, all brokers in the domain are affected. Without the -e and -a options, a broker configuration deployment is initiated.

With the -c option, deployment is cancelled to the specific broker.

-e EGName
(Optional) The name of the execution group to which to deploy. The -b and -a options must also be specified with this option.
-aBARFileName
(Optional) The name of the BAR (broker archive) file that is to be used for a message flow or message set deployment. The -b and -e options must also be specified with this option.

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

-t
(Optional) Deploy all the topics configuration information.
  • When used in conjunction with the -m option, it causes the complete topics hierarchy to be deployed to all brokers in the domain.
  • When used without the -m option, it 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 option specifies that the topology configuration should be deployed. Information is deployed to all brokers in the domain if the -m option is also set, otherwise the information is deployed only to brokers with a changed topology configuration.
-c
(Optional) Tells the Configuration Manager to stop waiting for responses to previously submitted deployment requests. If used with the -b option, the Configuration Manager stops waiting for outstanding deployment responses from the specified broker; without the -b option, the Configuration Manager stops waiting for responses to all outstanding deployment requests in the domain.

Specify the -c option 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 in synchronization with the broker.

-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 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) Describes the set of objects to be removed from the execution group. Multiple deployed files can be specified, separated by the ":" character.

Objects of all types can be specified, but if an ambiguous object name is specified (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, the fully qualified name of the objects to remove must be specified, for example "top.dictionary:top.cmf".

-v TraceFileName
(Optional) Sends the internal Configuration Manager Proxy trace to the specified file.
-m -complete
(Optional) Deploy complete information:
  • For a BAR file deploy, -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. In this case, 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 deploy, -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 deploy this option is not valid.
  • For a topic tree deploy, -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 operation, the option is ignored.
Start of change

Usage note

If you enter:
mqsideploy -i cm_name -p port -q cm_qm -l  -m 
the command attempts to run mqsideploy using WebSphere MQ Java client code. This is not allowed on z/OS and the following error occurs:
BIP1046E: Unable to connect with the Configuration Manager's queue manager
Depending on the version of WebSphere MQ that is used, 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
Connecting to the local Configuration Manager with the parameters -i and -p, therefore, forces the command into a local mode.
End of change

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, 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 deploy:
  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.

Note that, if there are no other objects called top and bar deployed to the execution group, the value of the -d option can be shortened 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. To specify a specific broker on which to cancel a deployment use the -b parameter:
  mqsideploy -n cm1.configmgr -c -w 900