probes::EchoPing.pm(3)

NAME

probes::EchoPing - an echoping(1) probe for SmokePing

OVERVIEW

Measures TCP or UDP echo (port 7) roundtrip times for SmokePing. Can also be used as a base class for other echoping(1) probes.

SYNOPSYS

 *** Probes ***
 + EchoPing

 binary = /usr/bin/echoping # default value

 *** Targets ***

 probe = EchoPing
 forks = 10

 menu = Top
 title = Top Menu
 remark = Top Menu Remark

 + PROBE_CONF

 # none of these are mandatory
 timeout = 1
 waittime = 1
 udp = no
 size = 510
 tos = 0xa0
 priority = 6

 + First
 menu = First
 title = First Target
 host = router.example.com

 # PROBE_CONF can be overridden here
 ++ PROBE_CONF
 size = 300

DESCRIPTION

Supported probe-specific variables:

binary: The location of your echoping binary.

forks: The number of concurrent processes to be run. See probes::basefork(3pm) for details.

Supported target-level probe variables (see echoping(1) for details of the options):

timeout: The "-t" echoping(1) option.

waittime: The "-w" echoping(1) option.

size: The "-s" echoping(1) option.

udp: The "-u" echoping(1) option. Values other than '0' and 'no' enable UDP.

fill: The "-f" echoping(1) option.

priority: The "-p" echoping(1) option.

tos: The "-P" echoping(1) option.

ipversion: The IP protocol used. Possible values are "4" and "6". Passed to echoping(1) as the "-4" or "-6" options.

extraopts: Any extra options specified here will be passed unmodified to echoping(1).

BUGS

Should we test the availability of the service at startup? After that it's too late to complain.

The location of the echoping binary should probably be a global variable instead of a probe-specific one. As things are, every EchoPing -derived probe has to declare it if the default (/usr/bin/echoping) isn't correct.

AUTHOR