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 the --admin-host and (optionally) the --admin-port parameters.

--integration-node-file integrationNodeFileName | -n 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.

--admin-host host --admin-port port | -i ipAddress -p 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 the --integration-node-file (-n) integrationNodeFileName parameter in the same command.

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

• --admin-host host (or -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.

• --admin-port port (or -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:

--https

(Optional) Specifies that HTTPS will be used for the connection to the integration node or server. If neither --https nor --no-https is specified, the connection is tried first with HTTPS and then without using HTTPS if the first attempt fails.

--no-https

(Optional) Specifies that HTTPS will not be used for the connection to the integration node or server. If neither --https nor --no-https is specified, the connection is tried first with HTTPS and then without using HTTPS if the first attempt fails.

--cacert cacertFile

(Optional) Specifies the path to the certificate file (in either PEM, P12, or JKS format) to be used to verify the integration node or server. If no cacert file is specified and default admin-ssl is enabled, the cacert file defaults to the default pem file for admin-ssl.

• The --cacert parameter is valid only if HTTPS is used for the connection, so it cannot be set together with the --no-https parameter. You can set --cacert when the --https parameter has been set or when neither the --https nor --no-https parameter has been set (in which case SSL is used by default).
• The --cacert parameter can be set only if the --admin-host parameter is specified without a URI, or if a URI is specified that starts with ssl://.

--cacert-password cacertPassword

(Optional) The password for password-protected cacert files.

• The --cacert-password parameter is valid only if HTTPS is used for the connection and if the --cacert parameter has been set. You cannot set it together with the --no-https parameter.
• The --cacert-password parameter can be set only if the --admin-host parameter is specified without a URI, or if a URI is specified that starts with ssl://.

--insecure

(Optional) Specifies that the certificate that is returned by the integration node or server will not be verified.

• The --insecure parameter is valid only if HTTPS is used for the connection, so it cannot be set together with the --no-https parameter. You can set --insecure when the --https parameter has been set or when neither the --https nor --no-https parameter has been set (in which case SSL is used by default).
• The --insecure parameter can be set only if the --admin-host parameter is specified without a URI, or if a URI is specified that starts with ssl://.

--bar-file BARFile | -a 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, specify the full path to the BAR file to deploy to an independent integration server.

mqsideploy --admin-host localhost --admin-port 7601 --bar-file C:\Users\IBM_ADMIN\IBM\ACET12\workspace\AppConnectToIIB\AppConnectToIIB.bar

You must also identify an integration server to deploy to. For example, either specify the --admin-host (-i) and --admin-port (-p) parameters for an independent integration server, or specify an integration node and the --integration-server (-e) parameter for an integration server.

--resources-to-delete resourcesToDelete | -d resourcesToDelete

(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 file names with a colon (:).

In IBM® App Connect Enterprise 13.0, you can delete deployed applications, shared libraries, and policy projects. To enable compatibility with earlier versions of IBM App Connect Enterprise, you can delete individual resources but only from the default application.

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

--integration-server integrationServerName | -e integrationServerName

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

--clear | -m

(Optional) This parameter specifies deployment of complete information:

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

• For a BAR file deployment, the --clear (or -m) parameter removes all currently deployed message flows and message sets from the integration server as part of the deployment. If you do not set --clear (or -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 the --resources-to-delete or -d parameter, the --clear (or -m) parameter is ignored.

--restart-all-applications

(Optional) This parameter specifies that all applications in the integration server are to be restarted as part of the deployment operation. Use this parameter to allow non-dynamic policies to be redeployed. For more information about non-dynamic policies, see Policy properties.

Restarting all applications has the following effects on the integration server and its resources:

• All active connections are disconnected
• All registered endpoints become temporarily unavailable
• All in-memory activity logs are cleared
• All flow statistics are reset
• All dynamic thread pool updates are removed
• Any ESQL shared variables are reset to their initialized values
• Any UDP global overrides are removed
• Any non-persistent changes are removed for flow statistics, monitoring, and user exits
• Message flows and applications return to their start-up state according to the value of their startMode parameter
• Errors are returned for any applications that cannot start

--trace traceFileName | -v traceFileName

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

--timeout-seconds timeoutValue | -w 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.