Difference between revisions of "Subagent:Ping"

From NetXMS Wiki
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:Ping Subagent}} This subagent can be used to measure ICMP ping responce times from one location to another. = Provided Parameters = When loaded, PING subagen...")
 
m (Text replacement - "^" to "{{deprecated}}")
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Ping Subagent}}
{{deprecated}}Information moved to documentation:
This subagent can be used to measure ICMP ping responce times from one location to another.


 
https://www.netxms.org/documentation/adminguide/icmp-ping.html
= Provided Parameters =
 
When loaded, PING subagent adds the following parameters to agent:
 
{| class="wikitable" style="width: 70%"
|-
! 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 =
 
{| 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 =
 
All configuration parameters related to PING subagent should be placed into '''*PING''' section of agent's configuration file. The following configuration parameters are supported:
 
{| class="wikitable"
|-
! Parameter !! Format !! Description !! Default value
|-
| DefaultPacketSize || ''bytes'' || Set default packet size to ''bytes''. || 46
|-
| PacketRate || ''packets'' || Set ping packet rate per minute. || 4
|-
| 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
|}
 
== Configuration Example ==
 
<syntaxhighlight lang="ini">
# This sample nxagentd.conf instructs agent to:
#  1. load PING subagent
#  2. Ping target 10.0.0.1 with default size (46 bytes) packets and 10.0.0.2 with 1000 bytes packets
#  3. Timeout for ping set to 1 second and pings are sent 12 times per minute (each 5 seconds)
 
MasterServers = netxms.demo
SubAgent = ping.nsm
 
*PING
Timeout = 1000
PacketRate = 12
Target = 10.0.0.1:target_1
Target = 10.0.0.2:target_2:1000
 
</syntaxhighlight>
 
= Notes =
 
PING subagent uses value of 10000 to indicate timed out requests.

Latest revision as of 18:13, 13 September 2022

This Wiki is deprecated and we are are currrently migrating remaining pages into product documentation (Admin Guide, NXSL Guide)

Information moved to documentation:

https://www.netxms.org/documentation/adminguide/icmp-ping.html

Retrieved from "https://wiki.netxms.org/index.php?title=Subagent:Ping&oldid=2005"