mqsichangeflowmonitoring command - Windows, Linux and AIX systems

Some parameters have alternative long names; for example, -p and --admin-port are alternative parameter names of the administration REST API. The long names available are listed in the Parameters section.

integrationNodeName

This parameter identifies the name of a specific integration node. To connect to a remote integration node by name, you must also specify the --admin-host and (optionally) the --admin-port parameters.

--integration-node-file integrationNodeFileName | -n integrationNodeFileName

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

The file can be used to connect to an independent integration server. The connection details must not include a node name (integrationNodeName) and the host and port must be for an independent integration server.

Use this option if multiple users want to connect to the same integration node or integration server, or if you are using advanced connection parameters such as SSL. To learn more about how to create and use a .broker file, see Connecting to an integration node by creating a .broker file.

You can run a command that uses SSL to administer a remote integration node or integration server 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.

--admin-host host --admin-port port | -i ipAddress -p port

These parameters identify a host and port for an integration node or independent integration server, for connections that do not require advanced connection parameters.

To connect to a specific remote integration node by name, you can add the prefix integrationNodeName. You cannot use the --integration-node-file (-n) integrationNodeFileName parameter in the same command.

For an integration node, any parameters that you omit assume default values.

• --admin-host host (or -i ipAddress). The hostname or IP address of the computer on which the integration node or server is running. If you do not specify this parameter, a value that represents the local computer is used.

  To connect to an independent integration server, the value is the host that you specified in the adminRestApiHost property in the server.conf.yaml configuration file for the integration server.

  If you want to connect to a secured integration node or 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.

• --admin-port port (or -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.

  To connect to an independent integration server, the value is the port that you set for the adminRestApiPort property in the server.conf.yaml configuration file. By default adminRestApiPort is set to 7600.

Other parameters:

-c | --control Control

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

• active - activate monitoring
• inactive - deactivate monitoring

-e | --integration-server IntegrationServerName

(Optional) Specify the name for the integration server to which the message flows that you want to be monitored are deployed. Alternatively, you can specify --all-integration-servers.

-f | --flow MessageFlow

(Optional) Specify the label for the message flow, for which the monitoring options are to be activated or updated. Alternatively, you can specify --all-flows.

-k | --application applicationName

(Optional) This parameter specifies the name of the application that contains the message flow to be monitored. Alternatively, you can specify --all-applications.

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

-y | --library libraryName

(Optional) This parameter specifies the name of the library that contains the message flow to be monitored. Alternatively, you can specify --all-libraries.

If you specify the -y parameter, you must also specify the -k(application name) parameter. If you specify the -f (message flow) parameter, you must also specify -k, and optionally -y.

--all-applications

(Optional) This parameter specifies all applications.

--all-flows

(Optional) This parameter specifies all message flows.

--all-integration-servers

(Optional) This parameter specifies all integration servers.

--all-libraries

(Optional) This parameter specifies all libraries.

-m | --monitoring-profile profile

(Optional) This parameter specifies the monitoring profile that is to be attached. The profile is either {policyProject}:profileName or profileName.

--non-persist

(Optional) This parameter specifies that the other settings that are specified by the command do not persist when the integration server is restarted or when the message flow is redeployed. At that point, the settings that are specified in the server.conf.yaml file or on the deployed message flow take effect. By default, this parameter is not set. Therefore, the settings that you specify with this command persist when the integration server or node is restarted and when the message flow is redeployed.