mqsideleteexecutiongroup command

Supported platforms

Windows
Linux® and UNIX systems
z/OS®. Run this command by customizing and submitting BIPDLEG; see Contents of the integration node PDSE

Purpose

You must start the integration node before you can issue this command.

Syntax

integrationNodeSpec

Parameters

integrationNodeSpec

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

-e integrationServerName

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

-w timeoutSecs

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

-v traceFileName

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

Deprecation of the -q parameter

In previous versions of IBM® Integration Bus, you might have used the -q parameter for this command to define a connection to a queue manager. A queue manager connection is no longer used to connect to an integration node. The -q parameter is now deprecated, and is ignored if used. If you use the -q parameter, a BIP1922 warning is displayed.

Authorization

For information about platform-specific authorizations, see the following topics:

If you have enabled integration node administration security, you must also set up the authority that is detailed in Tasks and authorizations for administration security.

Responses

This command returns the following responses:

0: The command completed successfully.
2: (Failure) The integration node received the deployment request but was unable to process it successfully. See the messages issued from the utility (or the Administration log) for more information.
9: (Failure) The request has been submitted to the integration node, but no response was received before the timeout expired.
10: (Failure) Another user or application canceled the request operation before the integration node was able to process it.
98: The integration node is not running.
99: One or more of the parameters that you specified is invalid.

Examples

Delete an integration server called IS1 on the integration node defined by connection parameters specified by the file BKR1.broker.

  mqsideleteexecutiongroup -n BKR1.broker -e IS1

Delete an integration server IS2 on the integration node specified by the file FRED.broker. Wait 5 minutes for the integration node to tidy up related resources, and send output to trace.txt.

  mqsideleteexecutiongroup -n FRED.broker -e IS2 -w 300 -v trace.txt

Delete the integration server IS3 on the locally defined integration node MYBROKER.

  mqsideleteexecutiongroup MYBROKER -e IS3