Difference between revisions of "PING Subagent"

PING Subagent (view source)

Revision as of 20:54, 1 April 2012

342 bytes added , 20:54, 1 April 2012

→‎Provided Parameters

Victor

AutoPatrol, Bureaucrats, Administrators

683

edits

@@ Line 5: / Line 5: @@
 When loaded, PING subagent adds the following parameters to agent:
-== Icmp.AvgPingTime($1) ==
+{| class="wikitable"
+|-
-Average ICMP ping responce time from target $1 for last minute. Argument $1 can be either IP address or name specified in Target configuration record (see below).
+! 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($1) ==
+|-
+| 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).
-Last ICMP ping responce time from target $1. Argument $1 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($1,$2,$3) ==
+| 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 ping responce time from target $1. 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 $1 should be an IP address. Optional argument $2 specifies timeout in milliseconds. Default timeout is 1 second.
-Optional argument $3 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 =