Subagent:Ping - Revision history

AlexKirhenshtein: Text replacement - "^" to "{{deprecated}}"

2022-09-13T16:13:53Z

Text replacement - "^" to "{{deprecated}}"

← Older revision		Revision as of 16:13, 13 September 2022
Line 1:		Line 1:
	Information moved to documentation:		{{deprecated}}Information moved to documentation:

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

TatjanaDubrovica: Replaced content with "Information moved to documentation: https://www.netxms.org/documentation/adminguide/icmp-ping.html"

2017-11-24T14:57:36Z

Replaced content with "Information moved to documentation: https://www.netxms.org/documentation/adminguide/icmp-ping.html"

← Older revision		Revision as of 14:57, 24 November 2017
Line 1:		Line 1:
	~~{{DISPLAYTITLE~~:~~Ping Subagent}}~~		Information moved to documentation:
	~~This subagent can be used to measure ICMP ping response 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 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 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.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.
	\|-
	~~\| Icmp.PingStdDev(''target'') \|\| [http~~://en.~~wikipedia~~.org/~~wiki~~/~~Standard_deviation Standard deviation] of ICMP ping response time for ''target''. Argument ''target'' can be either IP address or name specified in Target configuration record (see below).~~
	\|}

	~~= Provided Lists =~~

	~~{\| class="wikitable"~~
	\|-
	~~! List !! Description~~
	\|-
	~~\| Icmp.Targets \|\| 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. Allowed values are from 1 to 60 and values below or above will be adjusted automatically. \|\| 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''. Allowed values are from 500 to 5000 and values below or above will be adjusted automatically. \|\| 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~~.

Tomas Kirnak: Fixed target list name

2017-03-16T21:26:08Z

Fixed target list name

← Older revision		Revision as of 21:26, 16 March 2017
Line 29:		Line 29:
	! List !! Description		! List !! Description
	\|-		\|-
	\| Icmp.~~TargetList~~ \|\| List of configured ping targets. Each line has the following fields, separated by spaces:		\| Icmp.Targets \|\| List of configured ping targets. Each line has the following fields, separated by spaces:
	* IP address		* IP address
	* Last response time (milliseconds)		* Last response time (milliseconds)

Victor at 16:59, 28 September 2012

2012-09-28T16:59:32Z

← Older revision		Revision as of 16:59, 28 September 2012
Line 19:		Line 19:
	\| 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.		\| 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.
			\|-
			\| Icmp.PingStdDev(''target'') \|\| [http://en.wikipedia.org/wiki/Standard_deviation Standard deviation] of ICMP ping response time for ''target''. Argument ''target'' can be either IP address or name specified in Target configuration record (see below).
	\|}		\|}

Lweidig: Removed 10000 in ICMP.Ping missed it at bottom. Fixed spelling for response.

2012-08-22T21:06:36Z

Removed 10000 in ICMP.Ping missed it at bottom. Fixed spelling for response.

← Older revision		Revision as of 21:06, 22 August 2012
Line 1:		Line 1:
	{{DISPLAYTITLE:Ping Subagent}}		{{DISPLAYTITLE:Ping Subagent}}
	This subagent can be used to measure ICMP ping ~~responce~~ times from one location to another.		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 ~~responce~~ time from ''target'' for last minute. Argument ''target'' can be either IP address or name specified in Target configuration record (see below).		\| 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 ~~responce~~ time from ''target''. Argument ''target'' can be either IP address or name specified in Target configuration record (see below).		\| 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 ~~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.		\| 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. ~~If the ping fails the value of 10000 will be returned.~~		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.
	\|}		\|}

Lweidig: Added in upper / lower boundaries for values and return value for ICMP.Ping if not successful.

2012-08-22T21:03:27Z

Added in upper / lower boundaries for values and return value for ICMP.Ping if not successful.

← Older revision		Revision as of 21:03, 22 August 2012
Line 18:		Line 18:
	\|-		\|-
	\| 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.		\| 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.		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. If the ping fails the value of 10000 will be returned.
	\|}		\|}

Line 47:		Line 47:
	\| DefaultPacketSize \|\| ''bytes'' \|\| Set default packet size to ''bytes''. \|\| 46		\| DefaultPacketSize \|\| ''bytes'' \|\| Set default packet size to ''bytes''. \|\| 46
	\|-		\|-
	\| PacketRate \|\| ''packets'' \|\| Set ping packet rate per minute. \|\| 4		\| PacketRate \|\| ''packets'' \|\| Set ping packet rate per minute. Allowed values are from 1 to 60 and values below or above will be adjusted automatically. \|\| 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''		\| 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 response timeout to ''milliseconds''. Allowed values are from 500 to 5000 and values below or above will be adjusted automatically. \|\| 3000
	\|}		\|}

Victor: 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..."

2012-06-28T10:20:24Z

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..."

New page

{{DISPLAYTITLE: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:

{| 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.