PING Subagent
This subagent can be used to measure ICMP ping responce times from one location to another.
Provided Parameters
When loaded, PING subagent adds the following parameters to agent:
| Parameter | Description |
|---|---|
| Icmp.AvgPingTime(target) | Average ICMP ping responce time from target for last minute. Argument target can be either IP address or name specified in Target configuration record (see below). |
| Icmp.LastPingTime(target) | Last ICMP ping responce time from target. Argument target can be either IP address or name specified in Target configuration record (see below). |
| Icmp.PacketLoss(target) | ICMP ping packet loss (in percents) for target. Argument target can be either IP address or name specified in Target configuration record (see below). |
| Icmp.Ping(target,timeout,psize) | ICMP ping responce time from target. Agent will send echo request as soon as it receives request for paramter's value, and will return responce time for that particular request. Argument target should be an IP address. Optional argument timeout specifies timeout in milliseconds. Default timeout is 1 second. Optional argument psize specifies packet size in bytes, including IP header. If this argument is omited, value from DefaultPacketSize configuration parameter will be used.
Please note that other parameters just returns result of background ping process, while this parameter waits for actual ping completion and then returns the result. Because of this behavior, it is not recommended to use Icmp.Ping parameter for instant monitoring, only for occasional tests. For instant monitoring, you should configure targets for background ping and use Icmp.AvgPingTime or Icmp.LastPingTime parameters to retrieve results. |
Icmp.TargetList
List of configured ping targets.
Configuration file
All configuration parameters related to PING subagent should be placed into *PING section of agent's configuration file. The following configuration parameters are supported:
DefaultPacketSize = <bytes>
Set default packet size.
Target = <ip>:<name>:<bytes>
Add target with IP address <ip> to background ping target list and assign a name <name> to it. Name field is optional and can be omited.
Timeout = <milliseconds>
Set timeout for background ping requests. Default timeout is 3 seconds.
Notes
PING subagent uses value of 10000 to indicate timed out requests.