fteShowAgentDetails (display WebSphere MQ File Transfer Edition agent details)

Use the fteShowAgentDetails command to display the details of a particular WebSphere® MQ File Transfer Edition agent. These are the details that are stored by its WebSphere MQ File Transfer Edition coordination queue manager.

Purpose

You can run the fteShowAgentDetails command from any system that can connect to the coordination queue manager. The agent details are directed to the standard output device (STDOUT). The fteShowAgentDetails command lists the following details for a particular WebSphere MQ File Transfer Edition agent:
  • Agent name
  • Agent type
  • Agent description
  • Operating system
  • Agent time zone
  • Agent availability status
  • Agent queue manager
  • Agent queue manager transport type
  • Agent queue manager host name
  • Agent queue manager port (applies to client transport mode only)
  • Agent queue manager channel (applies to client transport mode only)
  • If the agent is a protocol bridge agent, its protocol bridge server host name or IP address. From Version 7.0.4.1 with the new function enabled, this entry displays the host server of the default protocol bridge server, if a default server has been configured.
  • From Version 7.0.4.1 with the new function enabled, if the agent is a protocol bridge agent this entry indicates whether the agent can have multiple endpoints.
  • If the agent is a web agent, the name of the Web Gateway that the agent is a component of
  • If the agent is a Connect:Direct® bridge agent, the name of the node it connects to
  • If the agent is a Connect:Direct bridge agent, the host name or IP address of the system where the node is located and the port number that the node listens on
When specified with the -v parameter the command also lists the following details for the WebSphere MQ File Transfer Edition agent:
  • Agent host name
  • Agent product version
  • Agent build level
  • Agent trace First Failure Data Capture (FFDC) specification
  • Maximum number of source transfers
  • Maximum number of queued transfers
  • Maximum number of destination transfers
  • Current source transfer states
  • Current destination transfer states

This command uses the coordination.properties file to connect to the coordination queue manager.

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 Properties files for WebSphere MQ File Transfer Edition for more 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 Agent status message format. The status information produced by the fteShowAgentDetails 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 agent.properties file.

For a list of the possible agent status values and their meanings, see Agent status values.

For a list of agent trace values and FFDC specifications and their meanings, see fteSetAgentTraceLevel (set WebSphere MQ File Transfer Edition agent trace level V7.0.3 or later)

Syntax

Syntax diagram format

           

Read syntax diagramSkip visual syntax diagram
fteShowAgentDetails

>>-fteShowAgentDetails------------------------------------------>

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

Parameter

-bl
Optional. Additionally outputs the product build level for the agent.

-p configuration_options
Optional. This parameter determines the set of configuration options that is used to issue the request to display the details of an agent. 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.

-v
Optional. Specifies verbose mode, which generates additional output for the agent, including the product build level and a list of transfer states for each of the current source and destination transfers.

Version 7.0.4.1 (with the new function enabled) and later also includes the agent host name, product version, trace level, and First Failure Data Capture (FFDC) specification.

The current transfer information is obtained from the agent status publication, which is described in Agent status message format. Therefore this transfer information is only accurate to within the value of the agentStatusPublishRateLimit property. For more details about this property, see The agent.properties file.

agent_name
Required. The name of the WebSphere MQ File Transfer Edition agent that you want to start.

-? or -h
Optional. Displays command syntax.

Example

In this example the verbose details for agent AGENT1 are displayed.
fteShowAgentDetails -v AGENT1

The output from this command for an agent that connects to its queue manager in client mode is as follows:

Agent Information:
    Name: AGENT1
    Description: Test agent
    Operating System: Windows XP
    Time Zone: Greenwich Mean Time
    Build Level: f000-20091109-1044

Agent Availability Information:
    Status:               RUNNING
    Status Details:       The agent is running and is publishing its status at 
                          regular intervals. The last update was received 
                          within the expected time period.

Queue Manager Information:
    Name: QM_JUPITER
    Transport: Client
    Host: dhcp-9-20-98-97.hursley.ibm.com
    Port: 1414
    Channel: SYSTEM.DEF.SVRCONN

Maximum Number of Running Source Transfers: 25
Maximum Number of Queued Source Transfers: 1000
Source Transfer States:
    TransferId                                          State
    414d51204d49414f5720202020202020822c5b4a038c0b20    started
    414d51204d49414f5720202020202020822c5b4a378c0b20    progress

Maximum Number of Running Destination Transfers: 25
Destination Transfer States:
    No current transfers    

The output from this command for an agent that connects to its queue manager in bindings mode is as follows:

Agent Information:
    Name: AGENT1
    Description: Test agent
    Operating System: Windows XP
    Time Zone: Greenwich Mean Time
    Build Level: f000-20091109-1044

Agent Availability Information:
    Status:               RUNNING
    Status Details:       The agent is running and is publishing its status at 
                          regular intervals. The last update was received 
                          within the expected time period.

Queue Manager Information:
    Name: QM_JUPITER
    Transport: Bindings

Maximum Number of Running Source Transfers: 25
Maximum Number of Queued Source Transfers: 1000
Source Transfer States:
    No current transfers

Maximum Number of Running Destination Transfers: 25
Destination Transfer States:
    TransferId                                          State
    414d51204d49414f5720202020202020822c5b4a648c0b20    progress
    414d51204d49414f5720202020202020822c5b4a346c0b20    progress

In this example, the results for a Connect:Direct bridge agent are displayed.

fteShowAgentDetails AG_CD1
5655-U80, 5724-R10 Copyright IBM Corp.  2008, 2018.  ALL RIGHTS RESERVED
Agent Information:
    Name:                         AG_CD1
    Type:                         Connect:Direct bridge
    Description:
    Connect:Direct Node Name:     CDNODE
    Connect:Direct Node Host:     localhost:1363
    Operating System:             Windows Server 2003
    Time Zone:                    Greenwich Mean Time

Agent Availability Information:
    Status:                       STOPPED
    Status Details:               The agent has been stopped. It was shut down
                                  in a controlled manner.

Queue Manager Information:
    Name:                         QM_JUPITER
    Transport:                    Bindings

In this example for Version 7.0.4.1 (with the new function enabled) and later, the verbose details for agent AGENT1 are displayed.

fteShowAgentDetails -v AGENT1 

The output from this command for an agent that connects to its queue manager in client mode is as follows:

Agent Information:
    Name:                 AGENT1
    Type:                 Standard
    Description:          Test Agent
    Operating System:     Linux
    Host Name:            HOSTNAME1
    Time Zone:            Greenwich Mean Time
    Product Version:      7.0.4.1
    Build Level:          f000-xyz-20110711-1701
    Trace Level:          com.ibm.wmqfte.Agent=all
                          com.ibm.wmqfte.common=all
    Trace FFDC:           com.ibm.wmqfte.common:Any
                          com.ibm.wmqfte.Agent:1

Agent Availability Information:
    Status:               RUNNING
    Status Details:       The agent is running and is publishing its status at 
                          regular intervals. The last update was received 
                          within the expected time period.

Queue Manager Information:
    Name:                 QM_JUPITER
    Transport:            Client
    Host:                 dhcp-9-20-98-97.hursley.ibm.com
    Port:                 1414
    Channel:              SYSTEM.DEF.SVRCONN

Maximum Number of Running Source Transfers: 25
Maximum Number of Queued Source Transfers: 1000
Source Transfer States:
    No current transfers

Maximum Number of Running Destination Transfers: 25
Destination Transfer States:
    No current transfers

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/show_agent_cmd.htm