fte:ping
Pings an agent to elicit a response and so determines if the agent is able to process transfers.
Attributes
- agent
- Required. Specifies the agent to submit the fte:ping request
to. The value is in the form:
agentname@qmgrname
whereagentname
is the name of the agent andqmgrname
is the name of the queue manager that this agent is directly connected to. - cmdqm
- Optional. The command queue manager to submit the request to.
Specify this information in the form
qmgrname@host@port@channel
, where:qmgrname
is the name of the queue managerhost
is the optional host name of the system where the queue manager is runningport
is the optional port number that the queue manager is listening onchannel
is the optional SVRCONN channel to use
host
,port
, orchannel
information for the command queue manager, the connection information specified in the command.properties file is used. For more information, see The command.properties file. - rcproperty
- Required. Names a property to store the return code of the ping operation in.
- timeout
- Optional. The maximum amount of time, in seconds, for the task
to wait for the agent to respond. The minimum timeout is zero seconds,
however a timeout of minus one can also be specified such that the
command waits forever for the agent to respond. If no value is specified
for the
timeout
then the default is to wait up to 5 seconds for the agent to respond.
Example
This example sends a fte:ping request toagent1
hosted by qm1
. The fte:ping request
waits 15 seconds for the agent to respond. The outcome of the fte:ping request
is stored in a property called ping.rc
.
<fte:ping agent="agent1@qm1" rcproperty="ping.rc" timeout="15"/>
Return codes
- 0
- Command completed successfully.
- 2
- Command timed out.