mqsideploy command - Windows, Linux, and AIX systems

Some parameters have alternative long names; for example: -p and --admin-port are alternative parameter names of the port number for the administration REST API. The long names available are listed in the Parameters section.

integrationNodeName

This parameter identifies the name of a specific integration node. To connect to a remote integration node by name, you must also specify -i and (optionally) -p.

-n integrationNodeFileName | --integration-node-file integrationNodeFileName

This parameter identifies the name of a .broker file that contains the connection details for an integration node or independent integration server. 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.

The file can be used to connect to an independent integration server. The connection details must not include a node name (integrationNodeName) and the host and port must be for an independent integration server.

Use this option if multiple users want to connect to the same integration node or integration server, or if you are using advanced connection parameters such as SSL. To learn more about how to create and use a .broker file, see Connecting to an integration node by creating a .broker file.

You can run a command that uses SSL to administer a remote integration node or integration server over a secured channel. You must specify the keystore and truststore password for the connection that is using the IBM_JAVA_OPTIONS environment variable. For more information, see Resolving problems when running commands.

-i ipAddress, -p port | --admin-host ipAddress, --admin-port port

These parameters identify a host and port for an integration node or independent integration server, for connections that do not require advanced connection parameters.

To connect to a specific remote integration node by name, you can add the prefix integrationNodeName. You cannot use -n integrationNodeFileName in the same command.

For an integration node, any parameters that you omit assume default values.

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

  To connect to an independent integration server, the value is the host that you specified in the adminRestApiHost property in the server.conf.yaml configuration file for the integration server.

  If you want to connect to a secured integration node or server as a specific user, provide the security credentials as a URI in the following format: tcp://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.

  To connect to an independent integration server, the value is the port that you set for the adminRestApiPort property in the server.conf.yaml configuration file. By default adminRestApiPort is set to 7600.

Other parameters:

-a BARFile | --bar-file BARFile

(Optional) This parameter specifies the BAR file that you want to use to deploy a message flow and other resources. The command must be able to access and read the BAR file; for example, on Windows using the full path to the BAR file to deploy to a independent integration server:

mqsideploy -i localhost -p 7601 -a C:\Users\IBM_ADMIN\IBM\ACET11\workspace\AppConnectToIIB\AppConnectToIIB.bar

You must also identify an integration server to deploy to; for example, by either specifying -i and -p parameters for a independent integration server, or by specifying an integration node and the -e parameter for an integration server.

-d deployedObjects | --resources-to-delete 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 | --integration-server integrationServerName

(Optional) This parameter specifies the name of the integration server on an integration node on which to perform the deploy action.

-m | --clear

(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 (with -d parameter), the -m parameter is ignored.

-v traceFileName | --trace traceFileName

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

-w timeoutValue | --timeout-seconds timeoutValue

(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.

For an integration node, set this parameter to a value greater than the sum of the node configuration timeout parameters ConfigurationChangeTimeout and InternalConfigurationTimeout, 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.