fteListMonitors (list WebSphere MQ File Transfer Edition resource monitors)

Use the fteListMonitors command to list all of the existing resource monitors in a WebSphere® MQ File Transfer Edition network using the command line.

Purpose

The fteListMonitors command is supported on WebSphere MQ File Transfer Edition Version 7.0.1 and later.

The fteListMonitors command lists existing resource monitors. You can filter the command output by specifying an agent name and a resource monitor name.

This command uses the coordination.properties file to connect to the coordination queue manager. For more information, see The coordination.properties file.

From Version 7.0.4.1 you can use the -ox parameter to export a resource monitor to an XML file. See fteCreateMonitor (create new resource monitor) for information on how to use this XML file.

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

Syntax diagram format

           

Read syntax diagramSkip visual syntax diagram
fteListMonitors

>>-fteListMonitors--+-------------------------------+----------->
                    '- -ma-- monitoring_agent_name -'   

>--+-----------------------+--+-----------------------+--------->
   '- -mn -- monitor_name -'  '- -ox -- xml_filename -'   

>--+-----+--+------------------------------+-------------------><
   '- -v-'  '- -p-- configuration_options -'   

Parameters

-ma (monitoring_agent_name)
Optional. Filters resource monitors by agent name using the pattern you provide as input. Asterisk (*) characters are interpreted as wildcards that match zero or more characters. If you do not specify the -ma parameter, all resource monitors associated with all agents for the default coordination queue manager are listed by default.

-mn (monitor_name)
Optional. Filters resource monitors by monitor name using the pattern you provide as input. Asterisk (*) characters are interpreted as wildcards that match zero or more characters. If you do not specify the -mn parameter, all resource monitors associated with all agents for the default coordination queue manager are listed by default.

-ox (xml_filename)
Optional. You must specify this parameter with the -ma and -mn parameters. Exports the resource monitor to an XML file which can then be used by the fteCreateMonitor command.

-v
Optional. Generates verbose output which includes additional information about the status of the monitor, including whether the monitor is started or stopped, the directory resource path being monitored and the trigger conditions.

-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.

Examples

In this example, all resource monitors associated with the monitoring agent (and source agent for the file transfers associated with the monitor) AGENT1 are listed:
fteListMonitors -ma AGENT1 
In this example the resource monitor MONITOR1 on AGENT1 is exported to the XML file filename1.xml:
fteListMonitors -ma AGENT1 -mn MONITOR1 -ox filename1.xml 

Return codes

0
Command completed successfully.
1
Command ended unsuccessfully.

Reference Reference

Feedback

Timestamp icon Last updated: Tuesday, 30 January 2018
http://www.ibm.com/support/knowledgecenter/SSEP7X_7.0.4/com.ibm.wmqfte.doc/list_monitors_cmd.htm