mqsi commands - common text

brokerSpec

(Required) 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 specified integration node. To connect to a remote integration node, you must also specify -i and -p.

-n integrationNodeFileName

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

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. To learn more about creating and using a .broker file, see Connecting to an integration node by creating a .broker file.

If you want to run a command that uses SSL to administer a remote integration node 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

These parameters identify the connection details for the integration node.

Use this option for connections to remote integration nodes that do not require advanced connection parameters.

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 secured integration 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.

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.

-c Control

(Required) The value to define the action to be applied to resource statistics collection:

• Specify active to start resource statistics collection
• Specify inactive to stop resource statistics collection

-e integrationServerName

(Required) The name of the integration server to create.

(Required) The name of the integration server to delete.

(Optional) The name of the integration server for which to start message flows. You must specify either -e or -g.

If you specify -e without -m or -j, the integration server is started. Message flows are started only if they were running when the integration server was stopped.

If you specify -e with -m or -j, the integration server must be running. If the integration server is stopped, the request is rejected.

(Optional) The name of the integration server for which to stop message flows. You must specify either -e or -g.

If you specify -e without -m or -j, the integration server is stopped. The state of every message flow (stopped or started) is retained, and started message flows are started when the integration server is started again.

If you specify -e with -m or -j, the integration server must be running. If the integration server is stopped, the request is rejected.

(Optional) The name of the integration server for which resource statistics collection is started or stopped.

If you do not specify -e, resource statistics collection is started or stopped for all integration servers on the integration node.

(Optional) The name of the integration server for which resource statistics collection status is reported.

If you do not specify -e, resource statistics status is reported for all integration servers on the integration node.

-g

(Optional) The specified message flow or flows are started on all integration servers on the specified integration node. You must specify either -e or -g.

If you specify -g without -m or -j, all integration servers are started, but message flows are started only if they were running when the integration server was stopped.

If you specify -g with -m or -j, the specified message flow or flows are started only if the integration server is running. The request checks all integration servers, and starts message flows on integration servers that are currently running. Error BIP2851 is reported for each integration server that is not running.

(Optional) The specified message flow or flows are stopped on all integration servers on the specified integration node. You must specify either -e or -g.

If you specify -g without -m or -j, all integration servers are stopped. The state of every message flow (stopped or started) is retained for each integration server, and started message flows are started when the integration server is started again.

If you specify -g with -m or -j, the specified message flow or flows are stopped only if the integration server is running. The request checks all integration servers, and stops message flows on integration servers that are currently running. Error BIP2851 is reported for each integration server that is not running.

-m flowName

(Optional) The name of the message flow being started.

(Optional) The name of the message flow being stopped.

You can specify only one message flow in a single command. If you want to stop all message flows deployed to the integration node, or to the integration server identified by -e, specify -j.

If you do not specify -m or -j, the integration server identified by -e (if specified), or all integration servers on this integration node, are started. Message flows that were running when the integration server was last stopped are also restarted.

If you do not specify -m or -j, the integration server identified by -e (if specified), or all integration servers on this integration node, are stopped.

-j

(Optional) All message flows in the specified integration server are started.

(Optional) All message flows in the specified integration server are stopped; the integration server is not stopped.

If you do not specify -j or -m, the integration server identified by -e (if specified), or all integration servers on this integration node, are started. Message flows that were running when the integration server was last stopped are also restarted.

If you do not specify -j or -m, the integration server identified by -e (if specified), or all integration servers on this integration node, are stopped.

integrationNodeName

(Optional) The name of the integration node to which the request is sent. The integration node must be defined on the local computer.

-ncfgParameterFileName

(Optional) The name of the local file that contains the integration node connection parameters.

-i

(Optional) This parameter specifies the host name or IP address of the integration node. If you do not specify this parameter, the default value "" (a pair of quotation marks) is used, which results in a local binding connection.

-p

(Optional) This parameter is the port number of the integration node. If you do not specify this parameter, the default value 4414 is used.

-u useridList

(Optional) This parameter reloads all entries in the security cache for the specified list of users (separated by colons). If you do not specify this parameter, all entries in the security cache are reloaded. For cached certificates, this value is the common name element value.

-w

(Optional) This parameter specifies the time in seconds that the utility waits to ensure that the command completed; the default value is 60.

-v

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

If you try to connect to a remote integration node by specifying the i or p parameters, or by using a connection parameter file (.broker), the command attempts to use WebSphere® MQ Java™ client code. This option is not supported on z/OS®, and returns the following error:

BIP1046E: Unable to connect with the integration node (name)

The reported reason code is MQRC_ENVIRONMENT_ERROR. You must specify a local queue manager.