ibmint deploy command

• Windows
• Linux®
• Linux on POWER®
• Linux on Z
• AIX®
• IBM® z/OS® Container Extensions (zCX)

You can use the ibmint deploy command to deploy resources from sources to an output destination.

You can control whether the ibmint deploy command uses SSL for connections to an integration node or server, by using the --https and --no-https parameters. If you always want to use SSL for the connection, specify the --https parameter. If you do not want to use SSL for the connection, specify the --no-https parameter. If you specify neither the --https nor --no-https parameter, the ibmint deploy command attempts to connect first using HTTPS and then without using HTTPS if the first attempt falls.

If you are connecting to a remote integration server, you can use the --cacert parameter to specify the path to the certificate file in either PEM, P12, or JKS format, and use the --cacert-password parameter to specify the password for password-protected cacert files.

You must specify at least one parameter to identify the input source in one of the following forms (a) or (b):

(a) --input-bar-file filePath

The name of the input BAR file to compile and deploy.

(b) --input-path directory

The directory to scan for resources to compile and deploy.

You must specify at least one parameter to identify the output destination in one of the following forms (a), (b), (c), (d), (e), (f), (g), (h), (i), (j), or (k):

(a) --output-work-directory directory

The working directory of an integration server.

(b) --output-integration-node nodeName --output-integration-server serverName

The name of a local integration node and managed server.

(c) --integration-server-file filepath

The name of a file that contains remote independent integration server connection parameters (*.broker).

(d) --integration-node-file filePath --output-integration-server serverName

The name of the file that contains remote integration node connection parameters (*.broker) and the name of a managed integration server.

The parameter --integration-node-file, identifies the name of a .broker file that contains the connection details for a remote integration node. 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. You cannot use --output-integration-node and --integration-node-file in the same command.

Use this option if multiple users want to connect to the same integration node or integration server. For more information, see Connecting to an integration node by creating a .broker file.

(e) --output-host host --output-port port --cacert cacertFile --cacert-password cacertPassword

The host name or IP address, and the port number of a remote independent integration server. Optionally followed by options concerning REST communications.

If you want to connect to an integration server over a secure connection, you can use the --cacert parameter to specify the path to a certificate file (in either PEM, P12, or JKS format), and the --cacert-password parameter to specify the password for password-protected cacert files.

(f) --output-host host --output-port port --output-integration-server serverName --output-integration-node nodeName

These parameters identify the host, port, serverName, and nodeName of a remote integration server for connections that do not require advanced connection parameters.

• --output-host host: The hostname or IP address of the computer on which the integration node is running.
• --output-port port: The port on which the web user interface HTTP connection listener is listening.
• --output-integration-server serverName: The name of the remote integration server.
• --output-integration-node nodeName: This parameter is optional for validation.

  If you want to connect to an integration server over a secure connection, you can use the --cacert parameter to specify the path to a certificate file (in either PEM, P12, or JKS format), and the --cacert-password parameter to specify the password for password-protected cacert files.

(g)--output-host host --output-port port --output-integration-server serverName --output-integration-node nodeName --cacert cacertFile --cacert-password cacertPassword

Specify a cacert when connecting to a secured integration node through an output host and port.

(h) --output-uri URI

URI for a remote integration server in the form tcp://[user[:password]@]host:port.

(i) --output-uri URI --cacert cacertFile --cacert-password cacertPassword

URI for a remote integration server in the form ssl://[user[:password]@]host:port. Optionally followed by options concerning REST communications.

If you want to connect to an integration server over a secure connection, you can use the --cacert parameter to specify the path to a certificate file (in either PEM, P12, or JKS format), and the --cacert-password parameter to specify the password for password-protected cacert files.

(j) --output-uri URI --output-integration-server serverName --output-integration-node nodeName

URI for a remote integration node in the form tcp://[user[:password]@]host:port . The nodeName is optional for validation.

(k) --output-uri URI --output-integration-server serverName --output-integration-node nodeName --cacert cacertFile --cacert-password cacertPassword

URI for a remote integration node in the form ssl://[user[:password]@]host:port, and the name of a managed integration server. The nodeName is optional for validation. Optionally followed by options concerning REST communications.

If you want to connect to an integration server over a secure connection, you can use the --cacert parameter to specify the path to a certificate file (in either PEM, P12, or JKS format), and the --cacert-password parameter to specify the password for password-protected cacert files.

--overrides-file filePath

(Optional) The name of the file that contains the overrides to be applied.

--java-version javaVersion

The major version of Java to be used. Valid values are 8 and 17. The default is 17.

--do-not-compile-java

(Optional) Prevent compilation of Java resources.

--compile-maps-and-schemas

(Optional) Enable compilation of maps and schemas.

--project projectName

(Optional) The name of the project to deploy. If you do not specify a project, all available projects are deployed. If you specify a project that does not exist, nothing is deployed and the command fails.

--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 --output-host parameter is specified, or if the --output-uri parameter is specified with a URI 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 --output-host parameter is specified, or if the --output-uri parameter is specified with a URI 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 --output-host parameter is specified, or if the --output-uri parameter is specified with a URI that starts with ssl://.

--trace filePath

(Optional) Send verbose internal trace to the specified file.

--restart-all-applications

(Optional) This parameter specifies that all applications in the integration server are to be restarted as part of the deploy 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

--help

(Optional) Use this parameter to display help information about the command.