MFT agent status message format
When a Managed File Transfer Agent is created or started, the agent publishes its details to the SYSTEM.FTE topic on its coordination queue manager (on the SYSTEM.FTE/Agents/agent name topic).
The following information is included:
- Maximum number of destination transfers
- Agent type
- Publish time (UTC)
- Agent declared host name
- Queue Manager channel
- Maximum number of source transfers
- Agent trace level
- Agent Interface version number
- Agent time zone
- Agent description (optional)
- Maximum number of queued transfers
- Agent status
- Queue Manager name
- Command time (UTC)
- Agent start time (UTC)
- Queue manager port number
- Queue manager standby
- Agent Standby instances
- Agent OS name (Linux/Windows/UNIX/others)
- Agent Name
- Agent product version number
- Agent status publish rate
- Agent version number
- Queue manager host name
- Destination transfer states. These states are listed in Agent transfer states
If the agent is a protocol bridge agent the following information is also included:
- Maximum number of queued transfers
- Protocol bridge end points (Single/Multiple)
- Queue Manager name
- Protocol bridge type (ftp, sftp, ftps)
- Agent status publish rate numbers
- Protocol bridge default server name
- Protocol bridge server host
- Agent interface version numbers
The agent status is republished whenever the agent transfer states change, but by default no more than every 30 seconds. You can change this default setting using the agentStatusPublishRateLimit agent property, which is described in Advanced agent properties: General.
The following example output shows the keys used for each data element in the agent status:<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
<entry key="SourceTransferStates">414d512043514d4c37413031202020201af84q67203d0040=CompleteReceivedTransfer</entry>
<entry key="maxDestinationTransfers">25</entry>
<entry key="agentType">STANDARD</entry>
<entry key="PublishTimeUTC">2024-12-05T04:49:31Z</entry>
<entry key="agentDeclaredHostName">mfthost.com</entry>
<entry key="queueManagerChannel">MFT.SVRCONN</entry>
<entry key="maxSourceTransfers">25</entry>
<entry key="agentTraceLevel"><?xml version="1.0" encoding="UTF-8"?><agentTraceStatus version="6.00" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="AgentTraceStatus.xsd"></agentTraceStatus></entry>
<entry key="agentInterfaceVersion">1.00</entry>
<entry key="agentTimeZone">Europe/London</entry>
<entry key="agentDescription"/>
<entry key="maxQueuedTransfers">1000</entry>
<entry key="AgentStatus">STARTED</entry>
<entry key="queueManager">QM1</entry>
<entry key="CommandTimeUTC">2024-12-05T04:49:24Z</entry>
<entry key="AgentStartTimeUTC">2024-12-05T04:49:23Z</entry>
<entry key="queueManagerPort">1499</entry>
<entry key="queueManagerStandby"/>
<entry key="DestinationTransferStates">414d51204d554e474f20202020202020d857374a60a72622=RunningTransfer</entry>
<entry key="agentStandbyInstances"><?xml version="1.0" encoding="UTF-8"?><agentStandbyStatus version="6.00"xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="AgentStandbyStatus.xsd"><Instances><instance agentHost="mftStandby.com" agentVersion="9.4.0.0"/></Instances></agentStandbyStatus></entry>
<entry key="agentOsName">Linux</entry>
<entry key="agentName">STANDARDAGENT</entry>
<entry key="agentProductVersion">9.4.0.0</entry>
<entry key="AgentStatusPublishRate">300</entry>
<entry key="agentVersion">1.0</entry>
<entry key="queueManagerHost">mfthost.com</entry>
</properties>
The following example output shows the keys used for each data element in the agent status
of a protocol bridge agent:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
<entry key="SourceTransferStates">414d512043514d4c37413031202020201af84q67203d0040=CompleteReceivedTransfer</entry>
<entry key="agentType">BRIDGE</entry>
<entry key="agentDeclaredHostName">mfthost.com</entry>
<entry key="agentDescription"/>
<entry key="maxQueuedTransfers">1000</entry>
<entry key="agentTimeZone">Europe/London</entry>
<entry key="agentOsName">Linux</entry>
<entry key="PublishTimeUTC">2023-11-04T09:18:44Z</entry>
<entry key="DestinationTransferStates">414d51204d554e474f20202020202020d857374a60a72622=RunningTransfer</entry>
<entry key="protocolBridgeEndPoints">Multiple</entry>
<entry key="queueManager">QM1</entry>
<entry key="agentProductVersion">9.4.0.0</entry>
<entry key="protocolBridgeType">ftp</entry>
<entry key="AgentStatusPublishRate">300</entry>
<entry key="maxSourceTransfers">25</entry>
<entry key="AgentStatus">STARTED</entry>
<entry key="maxDestinationTransfers">25</entry>
<entry key="agentName">BRIDGEAGENT</entry>
<entry key="protocolBridgeDefaultServerName">defaultftpserver.com</entry>
<entry key="protocolBridgeServerHost">ftpserver.example.org</entry>
<entry key="agentInterfaceVersion">6.00</entry>
<entry key="agentVersion">1.0</entry>
</properties>