ftePingAgent (checks whether a WebSphere MQ File Transfer Edition agent is active)
The ftePingAgent command pings a WebSphere® MQ File Transfer Edition agent to determine whether the agent is active and able to process transfers.
Purpose
The ftePingAgent command is supported on WebSphere MQ File Transfer Edition Version 7.0.1 and later.
Use the ftePingAgent command to check the status of a WebSphere MQ File Transfer Edition agent. 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
ftePingAgent >>-ftePingAgent--+------------------------------+---------------> '- -p ---configuration options-' >--+----------------------------+--+--------------------+-------> '- -m ---agent queue manager-' '- -w ---+---------+-' '-timeout-' >--agent_name--------------------------------------------------><
Parameters
- -p configuration options
- Optional. This parameter determines the set of configuration options that is used to issue the request to ping 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. See Configuration options for more information.
- -m queue manager
- Optional. The name of the queue manager that the agent you want to ping is connected to. If you do not specify the -m parameter the queue manager used is determined from the set of configuration options in use.
- -w timeout
- Optional. Specifies that the command should wait for up to timeout seconds
for the agent to respond. If you do not specify a timeout, or specify
a timeout value of -1, then the command waits indefinitely until the
agent responds. If you do not specify this option then the default
is to wait up to five seconds for the agent to respond.
In Version 7.0.4 or earlier, the dead letter queue might fill up with messages from ftePingAgent, when the agent is unable to service the ftePingAgent request in time. Version 7.0.4.1 and later changes this behavior so that if timeout has been specified, ftePingAgent command messages will time out after double the value of timeout rather than going to the designated dead letter queue. The command messages will not time out if the command has been set to wait indefinitely.
- agent name
- Required. The name of the WebSphere MQ File Transfer Edition agent that you want to ping.
- -? or -h
- Optional. Displays command syntax.
Example
In this example, the command pings the agent AGENT1, which is connected to QM_MERCURY. The command waits for up to 40 seconds for AGENT1 to respond before returning.ftePingAgent -m QM_MERCURY -w 40 AGENT1
Return codes
- 0
- Command completed successfully. The agent is active and able to process transfers.
- 1
- Command ended unsuccessfully. The command was not able to send a message to the agent.
- 2
- Command ended with a timeout. The command sent a message to the agent, but the agent did not respond within the time.