20
edits
Difference between revisions of "Subagent:Ping"
Jump to navigation
Jump to search
m
Removed 10000 in ICMP.Ping missed it at bottom. Fixed spelling for response.
(Added in upper / lower boundaries for values and return value for ICMP.Ping if not successful.) |
m (Removed 10000 in ICMP.Ping missed it at bottom. Fixed spelling for response.) |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:Ping Subagent}} | {{DISPLAYTITLE:Ping Subagent}} | ||
This subagent can be used to measure ICMP ping | This subagent can be used to measure ICMP ping response times from one location to another. | ||
| Line 11: | Line 11: | ||
! Parameter !! Description | ! Parameter !! Description | ||
|- | |- | ||
| Icmp.AvgPingTime(''target'') || Average ICMP ping | | Icmp.AvgPingTime(''target'') || Average ICMP ping response 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 | | Icmp.LastPingTime(''target'') || Last ICMP ping response 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.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 | | Icmp.Ping(''target'',''timeout'',''psize'') || ICMP ping response time from ''target''. Agent will send echo request as soon as it receives request for paramter's value, and will return response 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. | 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. | ||
|} | |} | ||