mqsistart command - Windows, Linux, and AIX platforms

Use the mqsistart command to start the specified integration node, integration servers that are managed by the specified integration node, or any components that are deployed to an integration server managed by the specified integration node. The command can also be used to start any components that are deployed to an independent integration server.

Purpose

Depending on which parameters you specify with the mqsistart command, you can start one or all of the integration servers, applications, or message flows under the integration node. When the command is used to start an integration node, the command does not start any listeners, channels, or channel initiators that are associated with the integration node.

When the mqsistart command is used to start an integration node, and a queue manager is associated with the integration node (defined by the mqsicreatebroker command), the queue manager is not started by the mqsistart command. The mqsistart command checks if the queue manager that is associated with the integration node is running, and if it is not, returns an error. To start the associated queue manager, use the command line. For more information, see the topics on starting and stopping a queue manager in the IBM® MQ documentation.

When you use this command to start an integration node, successful completion of the command indicates that the Windows service, or Linux® or AIX® daemon started successfully, and that the integration node startup is initiated. Check the Windows system event log or the Linux or AIX syslog to determine whether the integration node and all related software started successfully, are initially active, and remain in an active state.

If the integration node fails to start, all errors that prevented successful start-up that are detected by the integration node are recorded in the log. Continue to monitor the Windows system event log or the Linux or AIX syslog.

If a vault has been configured for the integration node, the correct vault key must be supplied when the integration node is started. To supply the vault key, you can specify the --vault-key, --ext-vault-key, or --vaultrc-location parameters on the mqsistart command, or you can set the MQSI_VAULT_KEY or MQSI_VAULTRC_LOCATION environment variables. If you specify none of these, the .mqsivaultrc file will be looked for in your HOME directory. If you are using the .mqsivaultrc file, it must be configured to contain the correct vault key.

An integration node can be configured to use an integration node vault, an external directory vault, or both. For example, when you create an integration node by running the mqsicreatebroker command, you can specify both --vault-key and --ext-vault-dir parameters, which configures the integration node to use both an integration node vault and an external directory vault. For example:
mqsicreatebroker EXTDIRVAULT --ext-vault-dir c:\temp\sharedvault --vault-key workdirpassword
When you subsequently start the integration node, you must provide the vault keys for both vaults configured on the integration node, as shown in the following example:
mqsistart EXTDIRVAULT --vault-key workdirpassword --ext-vault-key extdirpassword

The mqsistart command cannot be used to start an independent integration server. To start an independent integration server, use the IntegrationServer command. For more information, see Starting an integration server.

Usage notes

  • Except for an integration server, a component can be started by the mqsistart only if its parent component is running. For example, if the integration node INODE is stopped, the following attempt to start the integration server fails:
    mqsistart INODE -e intServer
  • An integration node cannot be started by using the mqsistart command with the -n | --integration-node-file parameter. This syntax can only be used to start components under the integration node, for example an integration server. To start an integration node, use the mqsistart command with the integrationNodeName parameter.
  • Before you start an integration node, you can configure the node-managed integration server to access databases from deployed message flows by customizing the command environment. This process is relevant only when you are starting an integration node. For more information, see Running database setup scripts before starting an integration node.

Syntax

Some parameters have alternative long names; for example,: -e and --integration-server are alternative parameter names of the integration server. The long names available are listed in the Parameters section.

Syntax for use with integration nodes

Read syntax diagramSkip visual syntax diagrammqsistartintegrationNodeName--integration-node-file integrationNodeFileName--integration-serverintegrationServerName--all-integration-servers--https--cacertcertFile--cacert-passwordcacertPassword--insecure--no-https--applicationapplicationName--all-applications--librarylibraryName--flowmessageFlow--all-flows--timeout-secondsnumber of seconds before the action is aborted--vault-keyvaultKey--vaultrc-locationmqsivaultrc_file_location--ext-vault-keyexternalDirectoryVaultKey--detail-levellevel

Syntax for use with independent integration servers

Read syntax diagramSkip visual syntax diagrammqsistart--admin-hosthostname--admin-portport--https --cacertcertFile--cacert-password cacertPassword--insecure --no-https--application applicationName--all-applications--library libraryName--flow messageFlow--all-flows--timeout-secondsnumber of seconds before the action is aborted--vault-keyvaultKey--vaultrc-locationmqsivaultrc_file_location--ext-vault-key externalDirectoryVaultKey--detail-levellevel

Parameters

Note: You must specify at least one parameter to identify the target integration node or independent integration server for this command, in one of the following forms:
integrationNodeName
Specify the name of the integration node that you want to start.

On Linux and AIX systems, all names are case-sensitive.

-i | --admin-host hostname -p | --admin-port port
Specify the hostname and port of the independent integration server where the components you want to start are deployed.

On Linux and AIX systems, all names are case-sensitive.

-n | --integration-node-file filename

File containing integration node connection parameters (*.broker)

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://.
-e | --integration-server integrationServerName
(Optional) Specify the name of the integration server that you want to start.

On Linux and AIX systems, all names are case-sensitive.

--all-integration-servers

(Optional) Indicates all integration servers under the specified integration node.

-k | --application application name

(Optional) Name of an application that is deployed to the specified integration server.

--all-applications

(Optional) Indicates all applications that are deployed to the specified integration server.

-y | --library library

(Optional) Static library name.

-f | --flow messageflow

(Optional) message flow name.

--all-flows

(Optional) Indicates all message flows.

-w | --timeout-seconds timeoutSeconds

(Optional) The number of seconds before the action is aborted.

--vault-key vaultKey
(Optional) The vault key that is used to access the vault where the credentials are stored. You can specify either the --vault-key or --vaultrc-location parameter, or you can set the MQSI_VAULT_KEY or MQSI_VAULTRC_LOCATION environment variable. If you specify none of these, the .mqsivaultrc file is looked for in your HOME directory.
--vaultrc-location mqsivaultrc_file_location
(Optional) The location of the .mqsivaultrc file that contains the vault key. You can specify either the --vaultrc-location or --vault-key parameter, or you can set the MQSI_VAULT_KEY or MQSI_VAULTRC_LOCATION environment variable. If you specify none of these options, the .mqsivaultrc file is looked for in your HOME directory.
--ext-vault-key externalDirectoryVaultKey
(Optional) The vault key that is used to access the external directory vault.
--detail-level
This parameter controls the detail level of response messages.
  • 0 = display summary information
  • 1 = display standard information (default)
  • 2 = display detailed information

Responses

  • BIP8012 Unable to connect to system components
  • BIP8013 Integration node does not exist
  • BIP8015 Integration node cannot be started
  • BIP8018 Integration node running
  • BIP8024 Unable to locate executable
  • BIP8025 Integration node disabled
  • BIP8026 Unable to start integration node
  • BIP8030 Unable to modify user privileges
  • BIP8116 Starts an integration node

Examples

To start the integration node INODE:
mqsistart INODE
To start an integration server managed by the integration node INODE:
mqsistart INODE -e intServer
To start all integration servers managed by the integration node INODE:
mqsistart INODE --all-integration-servers
To start an application that is deployed to an integration server managed by the integration node INODE:
mqsistart INODE -e intServer -k testApp
To start a message flow in a deployed application:
mqsistart INODE -e intServer -k testApp -f testFlow
To start an application that is deployed to an independent integration server:
mqsistart --admin-host localhost --admin-port 7600 --application testApp
To start a message flow within an application to an independent integration server:
mqsistart --admin-host localhost --admin-port 7600 --application testApp --flow testFlow