fteListAgents (list the MFT agents for a coordination queue manager)
Use the fteListAgents command to list all of the Managed File Transfer agents that are registered with a particular coordination queue manager.
Purpose
You can run the fteListAgents command from any system that can connect to the coordination queue manager. The following details for each agent are directed to the standard output device (STDOUT):- Agent name
- Agent queue manager
- If the agent is a protocol bridge agent, the agent name is appended with ( bridge )
- If the agent is a Connect:Direct® bridge agent, the agent name is appended with (Connect:Direct bridge)
- Agent status
This command uses the coordination.properties file to connect to the coordination queue manager. For more information, see The MFT coordination.properties 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. For more information, see Configuration options.
If an agent is not listed by the fteListAgents command, use the diagnosis flowchart in the following topic to locate and fix the problem: What to do if your MFT agent is not listed by the fteListAgents command.
Agent status information
The agent status information produced by this command is generated from the status messages that the agent publishes to the SYSTEM.FTE topic. These messages are described in the topic MFT agent status message format. The status information produced by the fteListAgents command gives the agent status at the time when the last status message was published.
The frequency of these status messages depends on the value of the agentStatusPublishRateLimit property. For more details about this property, see The MFT agent.properties file.
If the Status Age is surrounded by parenthesis, this indicates that the value is negative. This situation occurs if the system time of the machine, where the agent is running, is ahead of the system time of the coordination queue manager machine.
Syntax
Parameters
- -p configuration_options
- Optional. This parameter determines the set of configuration options that is used to issue the request to list agents. 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.
- -mquserid user_id
- Optional. Specifies the user ID to authenticate with the coordination queue manager.
- -mqpassword password
- Optional. Specifies the password to authenticate with the coordination queue manager. You must also specify the -mquserid parameter. If you specify -mquserid, but do not specify -mqpassword, you will be prompted to supply the associated password. The password will not be displayed.
- -v
- Optional. Specifies verbose mode. Verbose mode generates additional output that shows the number
of current managed transfers for each agent in the form
Source/Destination, where:
- Source is the current number of source transfers and queued transfers for the agent.
- Destination is the current number of destination transfers.
- -t
- Optional. Specifies terse mode. From IBM® MQ 9.1, the output includes the Status Age column by default. If you do not want to see the Status Age information, you can issue the command with the -t parameter to hide the column. For more information, see What to do if an agent is shown as being in an UNKNOWN state.
- pattern
- Optional. The pattern to use to filter the list of Managed File Transfer agents. This pattern is matched against the agent name. Asterisk (*) characters are interpreted as wildcards, that match any value, including zero characters.
- -? or -h
- Optional. Displays command syntax.
Example
fteListAgents "B*"
fteListAgents -p QM_EUROPE -v
The output from this command is as follows:
Agent Name: Queue Manager Name: Transfers: Status:
(Source/Destination)
BERLIN QM_BERLIN 7/0 RUNNING
LONDON QM_LONDON 0/0 RUNNING
MADRID QM_MADRID 0/1 UNREACHABLE
For
a list of the possible agent status values and their meanings, see the topic MFT agent status values.
fteListAgents -v "BRIDGE*"
The output from this command is as follows:
C:\Program Files\IBM\WMQFTE\bin>fteListAgents -v
5724-H72 Copyright IBM Corp. 2008, 2024. ALL RIGHTS RESERVED
Agent Name: Queue Manager Name: Transfers: Status:
(Source/Destination)
BRIDGE_FTP ( bridge ) QM_JUPITER 0/0 STOPPED
BRIDGE_CD1 (Connect:Direct bridge) QM_JUPITER 0/0 STOPPED
HA
by an agent name if that agent is highly available. You must
set highlyAvailable=true in the agent.properties
file for an agent to be started in highly available mode. Note that HA
is
displayed, even if there are no standby instances
running.
5724-H72 Copyright IBM Corp. 2008, 2024. ALL RIGHTS RESERVED
Command executed at 2019-05-15 13:21:08 IDT
Coordination queue manager time 2019-05-15 07:51:08 UTC
Agent Name: Queue Manager Name: Status: Status Age:
IMQFT02 ( bridge )(HA) MFTQM STOPPED 8:51:17
SRC (HA) MFTQM READY 0:04:50
DEST MFTQM READY 0:05:50
Return codes
- 0
- Command completed successfully.
- 1
- Command ended unsuccessfully.