fteStopMonitor (stop an MFT resource monitor)

The fteStopMonitor command stops a Managed File Transfer resource monitor from the command line.

Purpose

From IBM® MQ 9.3.0, you can use the fteStopMonitor command to stop 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 stop a resource monitor from anywhere, and are not restricted to the system where the agent that owns the resource monitor is running.

Syntax

fteStopMonitor

Parameters

-p configuration_options: Optional. This parameter determines the set of configuration options that is used to stop 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 fteStopMonitor 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 stop.
-w timeout: Optional. If you do not specify a timeout value, the default is to wait up to five seconds for the agent to respond.; The timeout value specifies the value in seconds for the agent to respond. If you specify a timeout value of minus one, the command waits forever 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 coordination queue manager.; When the -mqpassword parameter is specified, you must also specify the -mquserid parameter. If you specify -mquserid, but do not specify -mqpassword, you are prompted to supply the associated password, which will not be displayed.
The command defaults to using MQCSP authentication, and sends the user ID and password to be authenticated to the queue manager in an MQCSP structure.
-nolpw: Optional. Specify this parameter if the command connects to a queue manager that does not support passwords longer than 12 characters.; When the -nolpw parameter is specified, you must also specify the -mquserid parameter. If you specify -mquserid and -nolpw, but do not specify -mqpassword, you are prompted to supply the associated password, which will not be displayed.
Note: If you specify the -nolpw option, and the password is longer than 12 characters the command fails with error message BFGCL0829E.

Example 1: resource monitor and agent on the same machine

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

fteStopMonitor -mn MNTR -ma SOURCE

This command outputs the following messages:

BFGCL0813I: A request to stop 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.

BFGDM0069I: Monitor MNTR has been stopped.

Example 2 - resource monitor and agent running on different machines

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

fteStopMonitor -mn MNTR -ma SOURCE -mm SRCQM

This command outputs the following messages:

BFGCL0813I: A request to stop 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.

BFGDM0069I: Monitor MNTR has been stopped.

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 stopped state

The command outputs the following messages:

BFGCL0813I: A request to stop resource monitor 'MNTR' of agent 'SOURCE' has been issued.
BFGCL0815I: Resource monitor 'MNTR' of agent 'SOURCE' is already stopped.

The resource monitor is in an agent that is stopped

The command outputs the following messages:

BFGCL0813I: A request to stop 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:

BFGCL0813I: A request to stop 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.