fteStartMonitor (start an MFT resource monitor)

The fteStartMonitor command starts a Managed File Transfer resource monitor from the command line.

Purpose

From IBM® MQ 9.2.2, you can use the fteStartMonitor command to start a resource monitor without needing to stop or restart an agent.

You can run this command from any system where the Managed File Transfer commands component is installed, which means that you can start a resource monitor from anywhere, and are not restricted to the system where the agent that owns the resource monitor is running.

Syntax

fteStartMonitor

Parameters

-p configuration_options: Optional. This parameter determines the set of configuration options that is used to start a resource monitor. Use the name of a set of configuration options as the value for the -p parameter. By convention, this is the name of a coordination queue manager. If you do not specify this parameter, the default set of configuration options is used.
-ma agent_name: Required. The name of the agent running the resource monitor operation.
-mm queue_manager: Optional. The name of the queue manager that the agent is connected to.; The fteStartMonitor command connects to the command queue manager. If the command queue manager is also the agent queue manager for the monitoring agent, then the -mm parameter is optional, otherwise you must specify the agent queue manager with the -mm parameter.
-mn monitor_name: Required. The name of the resource monitor that you want to start.
-w timeout: Optional. Specifies to wait for up to timeout seconds for the agent to respond. If you do not specify a timeout, or specify a timeout value of minus one, then the command waits forever for the agent to respond. If you do not specify this option, then the default is to wait up to five seconds for the agent to respond.
-mquserid user_id: Optional. Specifies the user ID to authenticate with the command queue manager.
-mqpassword password: Optional. Specifies the password to authenticate with the command queue manager. You must also specify the -mquserid parameter. If you specify -mquserid but do not also specify -mqpassword, you are asked to supply the associated password by a prompt. The password is not displayed on the screen.

Example 1

The following command starts a resource monitor in an agent running on the same machine:

fteStartMonitor -mn MNTR -ma SOURCE

This command outputs the following messages:

BFGCL0816I: A request to start resource monitor 'MNTR' of agent 'SOURCE' has been issued. 
BFGCL0251I: The request has successfully completed.

The following event is logged in the agent's output0.log:

BFGDM0032I: Monitor MNTR has been started.

External return code = 0

Example 2

The following command starts a resource monitor in an agent running on a different machine:

fteStartMonitor -mn MNTR -ma SOURCE -mm SRCQM

This command outputs the following messages:

BFGCL0816I: A request to start resource monitor 'MNTR' of agent 'SOURCE' has been issued. 
BFGCL0251I: The request has successfully completed.

The following event is logged in the agent's output0.log:

BFGDM0032I: Monitor MNTR has been started.

Examples of other messages

If you receive any of the following messages, you can check the state of the agent by using the fteListMonitors command with the -v parameter. The -v parameter generates verbose output that includes additional information about the status of the resource monitor, including whether the resource monitor is started or stopped, the directory resource path that is being monitored and the trigger conditions.

The resource monitor is already in the started state

The command outputs the following messages:

BFGCL0816I: A request to start resource monitor 'MNTR' of agent 'SOURCE' has been issued. 
BFGCL0814I: Resource monitor 'MNTR' of agent 'SOURCE' is already running.

The resource monitor is in an agent that is stopped

The command outputs the following messages:

BFGCL0816I: A request to start resource monitor 'MNTR' of agent 'SOURCE' has been issued.
BFGCL0253W: No acknowledgement to command from agent within timeout.

The specified agent is unknown

The command outputs the following message:

BFGUB0009E: The following required property file is missing: 
"/root/mftdata/mqft/config/MFTHAQM/agents/UKNOWNAGENT/agent.properties"

The specified resource monitor cannot be found on the specified agent

The command outputs the following messages:

BFGCL081608I: A request to start resource monitor 'UNKNOWNMONITOR' of agent 'IJQ' has been issued.
BFGCL0250E: The monitor could not be found on the given agent.

Return codes

0: Command completed successfully.
1: Command ended unsuccessfully.