Difference between revisions of "PING Subagent"

From NetXMS Wiki
Jump to navigation Jump to search
Line 19: Line 19:
|}
|}


== Icmp.TargetList ==


List of configured ping targets.
= Provided Lists =
 
{| class="wikitable"
|-
! List !! Description
|-
| Icmp.TargetList || List of configured ping targets. Each line has the following fields, separated by spaces:
* IP address
* Last response time (milliseconds)
* Average response time (milliseconds)
* Packet loss (percents)
* Configured packet size
* Name
|}
 


= Configuration file =
= Configuration file =
Line 27: Line 40:
All configuration parameters related to PING subagent should be placed into '''*PING''' section of agent's configuration file. The following configuration parameters are supported:
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>
{| class="wikitable"
 
|-
Set default packet size.
! Parameter !! Format !! Description !! Default value
 
|-
 
| DefaultPacketSize || ''bytes'' || Set default packet size to ''bytes'' || 46
Target = <ip>:<name>:<bytes>
|-
 
| PacketRate || ''packets'' || Example || Example
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.
| Target || ''ip'':''name'':''psize'' || Add target with IP address ''ip'' to background ping target list and assign an optional name ''name'' to it. Target will be pinged using packets of ''psize'' bytes size. Name and packet size fields are optional and can be omited. This parameter can be given multiple times to add multiple targets. || ''none''
 
|-
 
| Timeout || ''milliseconds'' || Set response timeout to ''milliseconds''. || 3000
Timeout = <milliseconds>
|}
 
Set timeout for background ping requests. Default timeout is 3 seconds.




Revision as of 21:04, 1 April 2012

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.


Provided Lists

List Description
Icmp.TargetList List of configured ping targets. Each line has the following fields, separated by spaces:
  • IP address
  • Last response time (milliseconds)
  • Average response time (milliseconds)
  • Packet loss (percents)
  • Configured packet size
  • Name


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:

Parameter Format Description Default value
DefaultPacketSize bytes Set default packet size to bytes 46
PacketRate packets Example Example
Target ip:name:psize Add target with IP address ip to background ping target list and assign an optional name name to it. Target will be pinged using packets of psize bytes size. Name and packet size fields are optional and can be omited. This parameter can be given multiple times to add multiple targets. none
Timeout milliseconds Set response timeout to milliseconds. 3000


Notes

PING subagent uses value of 10000 to indicate timed out requests.

Retrieved from "https://wiki.netxms.org/index.php?title=PING_Subagent&oldid=80"