fteDeleteMonitor (delete an MFT resource monitor)

Use the fteDeleteMonitor command to stop and delete an existing Managed File Transfer resource monitor using the command line. Issue this command against the resource monitoring agent.

Purpose

Use the fteDeleteMonitor command to stop monitoring a resource and remove the monitor's definition from the monitoring agent. When you run this command, no more polls of the resource occur and no further tasks are started.

You can run the fteDeleteMonitor command from any system that can connect to the IBM® MQ network and subsequently route to the agent's queue manager. Specifically for the command to run, you must have installed a Managed File Transfer component (either Service or Agent) on this system and you must have configured this system's Managed File Transfer to communicate with the IBM MQ network. If no connectivity details are available, the agent queue manager details are used for connection instead, provided these details are available.

Specify the optional -p parameter for this command only if you want to use a set of configuration options different from your default set. See Configuration options for more information.

Syntax

fteDeleteMonitor

Read syntax diagramSkip visual syntax diagramfteDeleteMonitor-mamonitoring_agent_name  -mn monitor_name  -mm monitoring_agent_qmgr_name-mquseriduser_id-nolpw-mqpasswordpassword-nolpw-pconfiguration_options

Parameters

-ma monitoring_agent_name
Required. The name of the agent that performs the resource monitoring. This monitoring agent must also have been the source agent for the file transfer that you wanted to trigger.
-mn monitor_name
Required. The name that you assigned to this resource monitor. You can delete a resource monitor and then create a new monitor with the same name.
-mm monitoring_agent_qmgr_name
Optional. The name of the monitoring agent's queue manager. Because the monitoring agent and the source agent of the transfer the monitor triggered must be same, this queue manager is also your source agent's queue manager.
-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.

From IBM MQ 9.3, 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.
-p configuration_options
Optional. This parameter determines the set of configuration options to use to cancel the transfer. By convention use the name of a non-default coordination queue manager as the input for this parameter. The command then uses the set of properties files associated with this non-default coordination queue manager.
If you do not specify this parameter, the set of configuration options based on the default coordination queue manager is used.
-? or -h
Optional. Displays command syntax.

Example

In this example, the resource monitor MONITOR1 with a monitoring (and file transfer source agent) AGENT1 is deleted:
fteDeleteMonitor -ma AGENT1 -mm QM_JUPITER -mn MONITOR1

Return codes

Table 1. Return code identifiers and descriptions
Return code Description
0 Command completed successfully
1 Command ended unsuccessfully