IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

mqsideploy command - Windows, Linux, and UNIX systems

Use the mqsideploy command on Windows, Linux, and UNIX systems to make a deployment request to the broker.

Syntax


>>-mqsideploy--| brokerSpec |----------------------------------->

>--+--------------------------------------------------------------+-->
   '- -e --integrationServerName--+- -a --BARFileName--+------+-+-'   
                                  |                    '- -m -' |     
                                  '- -d --deployedObjects-------'     

>--+-------------------+--+---------------------+--------------><
   '- -w --timeoutSecs-'  '- -v --traceFileName-'   

brokerSpec

|--+- brokerName ----------------+------------------------------|
   +- -n --brokerFileName--------+   
   | .-------------------------. |   
   | V                         | |   
   '-----+- -i --ipAddress-+---+-'   
         +- -p --port------+         
         '- -q --qMgr------'

Parameters

brokerSpec

(Required) You must specify at least one parameter to identify the target broker for this command, in one of the following forms:

brokerName

This parameter identifies the name of a locally defined broker. You cannot use this option if the broker is on a remote computer.

-n brokerFileName

This parameter identifies the name of a file that contains the connection details for a local or remote broker.

Use this option if multiple users want to connect to the same broker, or if you are using advanced connection parameters such as SSL.

To create this file, right-click the broker in the IBM® Integration Explorer and select Export *.broker file. When prompted, navigate to the location in which you want to save the file and enter the file name; the extension .broker is appended automatically when you click Save. Include the location (path) and file name when you specify this parameter. You must ensure that the location is accessible when you run this command.

If you want to run a command that uses SSL to administer a remote broker over a secured channel, you must specify the keystore and truststore password for the connection using the IBM_JAVA_OPTIONS environment variable. See Resolving problems when running commands for further information.

-i ipAddress, -p port, -q qMgr

These parameters identify the connection details for the broker.

Use this option for connections to remote brokers that do not require advanced connection parameters.

If you choose this option, you must specify at least one of these three parameters; the order in which you specify them is insignificant. You cannot specify each parameter more than once.

Parameters that you omit assume default values:

-i ipAddress: The host name or the IP address of the computer on which the broker is running. If you do not specify this parameter, a value that represents the local computer is used.
-p port: The TCP port on which the broker's queue manager is listening. If you do not specify this parameter, the value 1414 is used.
-q qMgr: The name of the broker's queue manager. If you do not specify this parameter, a value that represents the default queue manager on the local computer is used.

-a BARFileName

(Optional) This parameter specifies the name of the broker archive (BAR) file that is to be used for deployment of the message flow and other resources. You must also specify the -e parameter with this option.

-d deployedObjects

(Optional) This parameter describes the set of objects that you want to remove from the integration server. You can specify multiple files to delete 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 integration server), 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".

-e integrationServerName

(Optional) This parameter specifies the name of the integration server to which to deploy. You must also specify the -a parameter with this option.

-m

(Optional) This parameter specifies deployment of complete information:

The default operation is a delta or incremental deployment. Use the -m parameter to override the default operation and run a complete deployment.

For a BAR file deployment, -m removes all currently-deployed message flows and message sets from the integration server as part of the deployment. If you do not set -m, the contents of the BAR file are deployed in addition to what is already deployed to the integration server. 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 remove message flow or message set operation, the -m parameter is ignored.

-v traceFileName

(Optional) This parameter sends internal debug trace information to the specified file.

-w timeoutSecs

(Optional) This parameter specifies the maximum time in seconds that the command waits for the broker to complete the request before returning.

You can set this parameter to a value in the range 1 - 2 145 336 164. If you do not provide a timeoutValue value, or you set a value less than 1 or greater than 2 145 336 164 is specified, an error is returned.

Set this parameter to a value greater than the sum of the configuration timeout parameters ConfigurationChangeTimeout and InternalConfigurationTimeout that you specified for the broker, if you want to ensure that a response is received within the timeoutValue period. If you set a smaller value, the response returned might indicate that the state of the deploy request is unknown.

Examples

The following examples show the use of the -n parameter to define the connection parameters for the broker; if you prefer, you can specify the i, p, and q parameters. If the broker is on the local computer, you can specify it by name.

Deploy a BAR file to the broker identified by the connection parameters in the file b1.broker, and remove all currently-deployed message flows and message sets from the integration server as part of the deployment. Allow 10 minutes for the broker to reply.

mqsideploy -n b1.broker -e default -a mybar.bar -m -w 600

Remove the message flow top and the dictionary bar from the integration server default on the broker identified by the connection parameters in the file b1.broker.

mqsideploy –n b1.broker –e default –d top.cmf:bar.dictionary

For information about using this command with SSL protected channels, see You want to run a command that uses SSL to administer a remote broker over a secured channel

an28520_.htm |

Last updated Friday, 21 July 2017