PING Subagent - Revision history

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

2022-09-13T16:13:47Z

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

← Older revision		Revision as of 16:13, 13 September 2022
Line 1:		Line 1:
	#REDIRECT [[Subagent:Ping]]		{{deprecated}}#REDIRECT [[Subagent:Ping]]

Victor: Redirected page to Subagent:Ping

2012-06-28T10:28:33Z

Redirected page to Subagent:Ping

← Older revision		Revision as of 10:28, 28 June 2012
Line 1:		Line 1:
	~~This subagent can be used to measure ICMP ping responce times from one location to another.~~		#REDIRECT [[Subagent:Ping]]


	~~= 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.~~

Macro: /* Provided Parameters */

2012-05-15T22:25:20Z

Provided Parameters

← Older revision		Revision as of 22:25, 15 May 2012
Line 6:		Line 6:
	When loaded, PING subagent adds the following parameters to agent:		When loaded, PING subagent adds the following parameters to agent:

	{\| class="wikitable"		{\| class="wikitable" style="width: 70%"
	\|-		\|-
	! Parameter !! Description		! Parameter !! Description
Line 19:		Line 19:
	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.
	\|}		\|}


	= Provided Lists =		= Provided Lists =

173.30.55.161: Change to use syntaxhighlight tag

2012-04-28T04:04:32Z

Change to use syntaxhighlight tag

← Older revision		Revision as of 04:04, 28 April 2012
Line 56:		Line 56:
	== Configuration Example ==		== Configuration Example ==

	<~~source~~ lang="ini">		<syntaxhighlight lang="ini">
	# This sample nxagentd.conf instructs agent to:		# This sample nxagentd.conf instructs agent to:
	# 1. load PING subagent		# 1. load PING subagent
Line 71:		Line 71:
	Target = 10.0.0.2:target_2:1000		Target = 10.0.0.2:target_2:1000

	</~~source~~>		</syntaxhighlight>


	= Notes =		= Notes =

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

Victor at 19:14, 1 April 2012

2012-04-01T19:14:01Z

← Older revision		Revision as of 19:14, 1 April 2012
Line 1:		Line 1:
	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 responce times from one location to another.


	= Provided Parameters =		= Provided Parameters =
Line 71:		Line 72:

	</source>		</source>


	= Notes =		= Notes =

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

Victor: /* Configuration Example */

2012-04-01T19:12:42Z

Configuration Example

← Older revision		Revision as of 19:12, 1 April 2012
Line 55:		Line 55:
	== Configuration Example ==		== Configuration Example ==

	<~~nowiki~~>		<source lang="ini">
	# This sample nxagentd.conf instructs agent to:		# This sample nxagentd.conf instructs agent to:
	# 1. load PING subagent		# 1. load PING subagent
Line 70:		Line 70:
	Target = 10.0.0.2:target_2:1000		Target = 10.0.0.2:target_2:1000

	</~~nowiki~~>		</source>

	= Notes =		= Notes =

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

Victor: /* Configuration file */

2012-04-01T19:09:40Z

Configuration file

← Older revision		Revision as of 19:09, 1 April 2012
Line 44:		Line 44:
	! Parameter !! Format !! Description !! Default value		! Parameter !! Format !! Description !! Default value
	\|-		\|-
	\| DefaultPacketSize \|\| ''bytes'' \|\| Set default packet size to ''bytes'' \|\| 46		\| DefaultPacketSize \|\| ''bytes'' \|\| Set default packet size to ''bytes''. \|\| 46
	\|-		\|-
	\| PacketRate \|\| ''packets'' \|\| ~~Example~~ \|\| ~~Example~~		\| 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''		\| 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''
Line 53:		Line 53:
	\|}		\|}

			== Configuration Example ==

			<nowiki>
			# 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

			</nowiki>

	= Notes =		= Notes =

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

Victor at 19:04, 1 April 2012

2012-04-01T19:04:32Z

← Older revision		Revision as of 19:04, 1 April 2012
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~~.

Victor: /* Provided Parameters */

2012-04-01T18:54:21Z

Provided Parameters

← Older revision		Revision as of 18:54, 1 April 2012
Line 5:		Line 5:
	When loaded, PING subagent adds the following parameters to agent:		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 ==		== Icmp.TargetList ==

	List of configured ping targets.		List of configured ping targets.


	= Configuration file =		= Configuration file =

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

2012-02-22T22:05:01Z

Created page with "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 ..."

New page

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:

== Icmp.AvgPingTime($1) ==

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

== Icmp.LastPingTime($1) ==

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.Ping($1,$2,$3) ==

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 =

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>

Set default packet size.

Target = <ip>:<name>:<bytes>

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.

Timeout = <milliseconds>

Set timeout for background ping requests. Default timeout is 3 seconds.

= Notes =

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