mqsichangeflowmonitoring command - Windows, Linux and UNIX systems

Use the mqsichangeflowmonitoring command on Windows, Linux® and UNIX systems to enable monitoring of message flows.

Syntax

Notes:

¹ See the parameter descriptions for information about valid combinations of the e, f, g, and j parameters.

Parameters

BrokerName

(Required) Specify the label of the integration node to which the message flows that you want to be monitored are deployed.

-c Control

(Optional) Specify the string value that controls monitoring for the specified message flows. Possible values are:

active - activate monitoring
inactive - deactivate monitoring

-e IntegrationServerName

(Optional) Specify the name for the integration server to which the message flows that you want to be monitored are deployed.

You must specify either -e or -g. If you do not specify one of these arguments you receive an error message.

-f MessageFlow

(Required) Specify the label for the message flow, for which the monitoring options are to be activated or updated.

You must specify either -f or -j. If you do not specify one of these arguments you receive an error message.

-g

(Optional) Specifies that the command applies to all integration servers that belong to the integration node.

You must specify either -e or -g. If you do not specify one of these arguments you receive an error message.

-i EventState

(Optional) Specify the string value that controls monitoring for the specified event source. Valid only when used with the -e and -f parameters. Possible values are:

enable - enable monitoring for the specified event sources.
disable - disable monitoring for the specified event sources.

-j

(Required) Specifies that the command applies to all message flows that belong to the integration server.

You must specify either -f or -j. If you do not specify one of these arguments you receive an error message.

Note: If you set the -g option for all integration servers, you must use -j instead of -f.

-k applicationName

(Optional) This parameter specifies the name of the application that contains the message flow to be monitored.

When you set this parameter, you must also set either the -f (message flow) parameter, or the -j (all message flows) parameter. To enable monitoring for a named message flow in a specific application, set the -k and -f parameters. To enable monitoring for all message flows in an application, set the -k and -j parameters.

You can use this parameter with the -y (library name) parameter to specify that the message flow is contained in a library referenced by the application.

-m MonitoringProfileName

(Optional) Specify the name of the monitoring profile which the specified message flows should use.

If there is no monitoring profile with the specified name on the specified integration node, the command completes successfully, and the message flows attempt to use the specified monitoring profile. Each message flow logs a warning in the User Trace to indicate that it was instructed to use a nonexistent monitoring profile. No event message is created. If a monitoring profile with the specified name is later deployed to the integration node, the message flows do not immediately begin to use it. A refresh of the monitoring state can be triggered by issuing the command again with the -c option to activate or reactivate monitoring.

-s EventSourceAddress

(Optional) Comma-separated list of the event sources to be enabled or disabled. Valid only when used with the -e and -f parameters. This value takes the form <node name>.<event source>, where <event source> is one of the following values:

'terminal.<terminal name>'
'transaction.Start'
'transaction.End'
'transaction.Rollback'

If a message flow contains two or more nodes with identical names, the event sources on those nodes cannot be accurately addressed. If this is attempted, behavior is undefined.

<node name> is the label of the node as known by the IBM® Integration Bus runtime components. If the node is in a subflow, the label reflects this. For example, flow A contains an instance of flow B as a subflow that is labeled 'myB'. Flow B contains an instance of a Compute node that is labeled 'myCompute'. The <node name> for the Compute node is 'myB.myCompute'.

If you issue this command with a comma separated list to enable or disable individual event sources, and you have not already issued the command with the -c parameter, monitoring is not activated for these event sources. To enable monitoring, reissue the command with the -c parameter set to active.

-y libraryName

(Optional) This parameter specifies the name of the library that contains the message flow to be monitored.

When you set this parameter, you must also set either the -f (message flow) parameter, or the -j (all message flows) parameter. To enable monitoring for a named message flow in a specific library, set the -k and -f parameters. To enable monitoring for all message flows in a library, set the -k and -j parameters.

Examples

Assign monitoringProfile1 to messageFlow1 in integration server default:

mqsichangeflowmonitoring IBNODE -e default 
     -f messageFlow1 -m monitoringProfile1

Activate monitoring for all message flows in all integration servers:

mqsichangeflowmonitoring WBRK_BROKER -c active -g -j

Activate monitoring for all message flows in application application1 in integration server default:

mqsichangeflowmonitoring IBNODE -c active -e default -k application1 -j

Activate monitoring for message flow myflow1 in library library1, referenced by application application1, in integration server default:

mqsichangeflowmonitoring IBNODE -c active -e default -y library1 -k application1 -f myflow1

Enable individual event sources:

mqsichangeflowmonitoring IBNODE 
     -e default 
     -f myMessageFlow 
     -s "Node1_Label.terminal.out,Node2_Label.terminal.in" 
     -i enable