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


mqsideploy command - z/OS

Use the mqsideploy command on z/OS® to make a deployment request to a local integration node.

Syntax

z/OS command - BIPDPLY

Read syntax diagramSkip visual syntax diagram
>>-mqsideploy--| brokerSpec |----------------------------------->

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

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

brokerSpec

|--+- integrationNodeName ---------+----------------------------|
   +- n= --integrationNodeFileName-+   
   +- i= --ipAddress-- -p --port---+   
   '-+- i= --ipAddress-+-----------'   
     '- p= --port------'               

z/OS console command

Synonym: dp

Read syntax diagramSkip visual syntax diagram
>>-+-deploy-+--------------------------------------------------->
   '-dp ----'   

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

>--+------------------+--+-------------------+-----------------><
   '- w=timeoutValue -'  '- v=traceFileName -'   

Parameters

brokerSpec
You must specify at least one parameter to identify the target integration node for this command, in one of the following forms:
integrationNodeName
This parameter identifies the name of a locally defined integration node.
n= integrationNodeFileName
This parameter identifies the name of a file that contains the connection details for a local integration node.

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

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
These parameters identify the connection details for the integration node.

If you are connecting to a remote integration node, you can additionally prefix integrationNodeName to explicitly set which integration node to connect to. You cannot use -n integrationNodeFileName in the same command.

Parameters that you omit assume default values:

  • i= ipAddress: The host name or IP address of the computer on which the integration node is running. If you do not specify this parameter, a value that represents the local computer is used.

    If you want to connect to a remote host name, provide the security credentials as a URI in the following format: protocol://user:password@hostname. If your password contains URI Reserved characters, you must convert these characters to the percent-encoded format. For more information, see A correct URL and password returns error BIP1939 when you attempt to connect to a remote host name in Resolving problems when running commands.

  • p= port: The port on which the web user interface HTTP connection listener is listening. If you do not specify this parameter, the value 4414 is used.
a= BARFileName
(Optional) This parameter specifies the name of the 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.

The BAR file can be in a local or remote file system, if the user ID or the integration node that is running the command can access the file and read it.

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 integration node 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 integration node, 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.

Deprecation of the q= parameter

In previous versions of IBM® Integration Bus, you might have used the q= parameter for this command to define a connection to a queue manager. A queue manager connection is no longer used to connect to an integration node. The q= parameter is now deprecated, and is ignored if used. If you use the q= parameter, a BIP1922 warning is displayed.

Examples

The following examples show the use of the n= parameter to define the connection parameters for the integration node. If the integration node is on the local computer, you can specify it by name.

Deploy a BAR file to the integration node identified by the connection parameters in the file INODE1.broker, and remove all deployed message flows and message sets from the integration server as part of the deployment. Allow 10 minutes for the integration node to reply.
mqsideploy n= INODE1.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 integration node identified by the connection parameters in the file INODE1.broker.
mqsideploy n= INODE1.broker e= default d= top.cmf:bar.dictionary
Deploy a BAR file by using the console command:
F IB01NODE,dp e=default,a=flows.bar

an28530_.htm | Last updated 2015-09-24 12:53:08