NAME

smokeping_config - Reference for the SmokePing Config File

OVERVIEW

SmokePing takes its configuration from a single central configuration file. Its location must be hardcoded in the smokeping script and smokeping.cgi.

The contents of this manual is generated directly from the configuration file parser.

The Parser for the Configuration file is written using David Schweikert Config::Grammar module. Read all about it in Config::Grammar.

The Configuration file has a tree-like structure with section headings at various levels. It also contains variable assignments and tables.

Warning: this manual is rather long. See smokeping_examples for simple configuration examples.

REFERENCE

GENERAL SYNTAX

The text below describes the general syntax of the SmokePing configuration file. It was copied from the Config::Grammar documentation.

'#' denotes a comment up to the end-of-line, empty lines are allowed and space at the beginning and end of lines is trimmed.

'\' at the end of the line marks a continued line on the next line. A single space will be inserted between the concatenated lines.

'@include filename' is used to include another file.

'@define a some value' will replace all occurrences of 'a' in the following text with 'some value'.

Fields in tables that contain white space can be enclosed in either "'" or """. Whitespace can also be escaped with "\". Quotes inside quotes are allowed but must be escaped with a backslash as well.

SPECIFIC SYNTAX

The text below describes the specific syntax of the SmokePing configuration file.

* General * (mandatory section)

General configuration values valid for the whole SmokePing setup.

The following variables can be set in this section:

owner (mandatory setting): Name of the person responsible for this smokeping installation.
imgcache (mandatory setting): A directory which is visible on your webserver where SmokePing can cache graphs.
imgurl (mandatory setting): Either an absolute URL to the imgcache directory or one relative to the directory where you keep the SmokePing cgi.
datadir (mandatory setting): The directory where SmokePing can keep its rrd files.
dyndir: The base directory where SmokePing keeps the files related to the DYNAMIC function. This directory must be writeable by the WWW server. It is also used for temporary storage of slave polling results by the master in the master/slave mode.
If this variable is not specified, the value of "datadir" will be used instead.
pagedir: Directory to store static representations of pages.
piddir (mandatory setting): The directory where SmokePing keeps its pid when daemonized.
sendmail: Path to your sendmail binary. It will be used for sending mails in connection with the support of DYNAMIC addresses.
offset: If you run many instances of smokeping you may want to prevent them from hitting your network all at the same time. Using the offset parameter you can change the point in time when the probes are run. Offset is specified in % of total interval, or alternatively as 'random'. I recommend to use 'random'. Note that this does NOT influence the rrds itself, it is just a matter of when data acquisition is initiated. The default offset is 'random'.
smokemail (mandatory setting): Path to the mail template for DYNAMIC hosts. This mail template must contain keywords of the form <##keyword##>. There is a sample template included with SmokePing.
cgiurl (mandatory setting): Complete URL path of the SmokePing.cgi
mailhost: Instead of using sendmail, you can specify the name of an smtp server and use perl's Net::SMTP module to send mail (for alerts and DYNAMIC client script). Several comma separated mailhosts can be specified. SmokePing will try one after the other if one does not answer for 5 seconds.
mailuser: username on mailhost, SmokePing will use this user to send mail (Net::SMTP).
mailpass: password of username on mailhost, SmokePing will use this password to send mail (Net::SMTP).
snpphost: If you have a SNPP (Simple Network Pager Protocol) server at hand, you can have alerts sent there too. Use the syntax snpp:someaddress to use a snpp address in any place where you can use a mail address otherwise.
contact (mandatory setting): Mail address of the person responsible for this smokeping installation.
display_name: What should the master host be called when working in master/slave mode. This is used in the overview graph for example.
syslogfacility: The syslog facility to use, eg. local0...local7. Note: syslog logging is only used if you specify this.
syslogpriority: The syslog priority to use, eg. debug, notice or info. Default is info.
concurrentprobes: If you use multiple probes or multiple instances of the same probe and you want them to run concurrently in separate processes, set this to 'yes'. This gives you the possibility to specify probe-specific step and offset parameters (see the 'Probes' section) for each probe and makes the probes unable to block each other in cases of service outages. The default is 'yes', but if you for some reason want the old behaviour you can set this to 'no'.
changeprocessnames: When using 'concurrentprobes' (see above), this controls whether the probe subprocesses should change their argv string to indicate their probe in the process name. If set to 'yes' (the default), the probe name will be appended to the process name as '[probe]', eg. '/usr/bin/smokeping [FPing]'. If you don't like this behaviour, set this variable to 'no'. If 'concurrentprobes' is not set to 'yes', this variable has no effect.
Default value: changeprocessnames = yes
tmail: Path to your tSmoke HTML mail template file. See the tSmoke documentation for details.
changecgiprogramname: Usually the Smokeping CGI tries to log any possible errors with an extended program name that includes the IP address of the remote client for easier debugging. If this variable is set to 'no', the program name will not be modified. The only reason you would want this is if you have a very old version of the CGI::Carp module. See the installation document for details.
Default value: changecgiprogramname = yes
linkstyle: How the CGI self-referring links are created. The possible values are

absolute: Full hostname and path derived from the 'cgiurl' variable
<a href="http://hostname/path/smokeping.cgi?foo=bar">
relative: Only the parameter part is specified
<a href="?foo=bar">
original: The way the links were generated before Smokeping version 2.0.4: no hostname, only the path
<a href="/path/smokeping.cgi?foo=bar">

The default is "relative", which hopefully works for everybody.

Default value: linkstyle = relative

precreateperms

If this variable is set, the Smokeping daemon will create its directory hierarchy under 'dyndir' (the CGI-writable tree) at startup with the specified directory permission bits. The value is interpreted as an octal value, eg. 775 for rwxrwxr-x etc.

If unset, the directories will be created dynamically with umask 022.

Example: precreateperms = 2755

* Database * (mandatory section)

Describes the properties of the round robin database for storing the SmokePing data. Note that it is not possible to edit existing RRDs by changing the entries in the cfg file.

The following variables can be set in this section:

step (mandatory setting): Duration of the base operation interval of SmokePing in seconds. SmokePing will venture out every step seconds to ping your target hosts. If 'concurrentprobes' is set to 'yes' (see above), this variable can be overridden by each probe. Note that the step in the RRD files is fixed when they are originally generated, and if you change the step parameter afterwards, you'll have to delete the old RRD files or somehow convert them.
pings (mandatory setting): How many pings should be sent to each target. Suggested: 20 pings. Minimum value: 3 pings. This can be overridden by each probe. Some probes (those derived from basefork.pm, ie. most except the FPing variants) will even let this be overridden target-specifically. Note that the number of pings in the RRD files is fixed when they are originally generated, and if you change this parameter afterwards, you'll have to delete the old RRD files or somehow convert them.

This section also contains a table describing the setup of the SmokePing database. Below are reasonable defaults. Only change them if you know rrdtool and its workings. Each row in the table describes one RRA.

 # cons   xff steps rows
 AVERAGE  0.5   1   1008
 AVERAGE  0.5  12   4320
     MIN  0.5  12   4320
     MAX  0.5  12   4320
 AVERAGE  0.5 144    720
     MAX  0.5 144    720
     MIN  0.5 144    720

column 0: Consolidation method.
column 1: What part of the consolidated intervals must be known to warrant a known entry.
column 2: How many steps to consolidate into for each RRA entry.
column 3: How many rows this RRA should have.

* Presentation * (mandatory section)

Defines how the SmokePing data should be presented.

The following variables can be set in this section:

template (mandatory setting): The webpage template must contain keywords of the form <##keyword##>. There is a sample template included with SmokePing; use it as the basis for your experiments. Default template contains a pointer to the SmokePing counter and homepage. I would be glad if you would not remove this as it gives me an indication as to how widely used the tool is.
charset: By default, SmokePing assumes the 'utf-8' character set. If you use something else, this is the place to speak up.
htmltitle: By default, SmokePing will render the title of the graph in the image, when set to 'yes' the title is inserted in the html page.
graphborders: By default, SmokePing will render gray border on a light gray background, if set to 'no' borders will be hidden and the background and canvas will be transparent.

The following sections are valid on level 1:

+overview (mandatory section): The Overview section defines how the Overview graphs should look.
The following variables can be set in this section:

width (mandatory setting): Width of the Overview Graphs.
height (mandatory setting): Height of the Overview Graphs.
range: How much time should be depicted in the Overview graph. Time must be specified as a number followed by a letter which specifies the unit of time. Known units are: seconds, minutes, hours, ddays, weeks, years.
max_rtt: Any roundtrip time larger than this value will be cropped in the overview graph. Units is seconds (for example, 0.800).
median_color: By default the median line is drawn in red. Override it here with a hex color in the format rrggbb. Note that if you work with slaves, the slaves medians will be drawn in the slave color in the overview graph.
strftime: Use posix strftime to format the timestamp in the left hand lower corner of the overview graph

+detail (mandatory section): The following variables can be set in this section:

width (mandatory setting): How many pixels wide should detail graphs be
height (mandatory setting): How many pixels high should detail graphs be
loss_background: Should the graphs be shown with a background showing loss data for emphasis (yes/no)?
If this option is enabled, uptime data is no longer displayed in the graph background.
logarithmic: should the graphs be shown in a logarithmic scale (yes/no)
unison_tolerance: if a graph is more than this factor of the median 'max' it drops out of the unison scaling algorithm. A factor of two would mean that any graph with a max either less than half or more than twice the median 'max' will be dropped from unison scaling
max_rtt: Any roundtrip time larger than this value will be cropped in the detail graph. Units is seconds (for example, 0.800).
strftime: Use posix strftime to format the timestamp in the left hand lower corner of the detail graph
nodata_color: Paint the graph background in a special color when there is no data for this period because smokeping has not been running (#rrggbb)

The detailed display can contain several graphs of different resolution. In this table you can specify the resolution of each graph.

Example:

 "Last 3 Hours"    3h
 "Last 30 Hours"   30h
 "Last 10 Days"    10d
 "Last 400 Days"   400d

column 0: Description of the particular resolution.
column 1: How much time should be depicted. The format is the same as for the age parameter of the Overview section.

The following sections are valid on level 2:

++loss_colors

In the Detail view, the color of the median line depends the amount of lost packets. SmokePing comes with a reasonable default setting, but you may choose to disagree. The table below lets you specify your own coloring.

Example:

 Loss Color   Legend
 1    00ff00    "<1"
 3    0000ff    "<3"
 1000 ff0000    ">=3"

column 0: Activate when the number of lost pings is larger or equal to this number
column 1: Color for this range.
column 2: Description for this range.

++uptime_colors

When monitoring a host with DYNAMIC addressing, SmokePing will keep track of how long the machine is able to keep the same IP address. This time is plotted as a color in the graphs background. SmokePing comes with a reasonable default setting, but you may choose to disagree. The table below lets you specify your own coloring

Example:

 # Uptime      Color     Legend
 3600          00ff00   "<1h"
 86400         0000ff   "<1d"
 604800        ff0000   "<1w"
 1000000000000 ffff00   ">1w"

Uptime is in days!

column 0: Activate when uptime in days is larger of equal to this number
column 1: Color for this uptime range.
column 2: Description for this range.

+charts

The SmokePing Charts feature allow you to have Top X lists created according to various criteria.

Each type of Chart must live in its own subsection.

 + charts
 menu = Charts
 title = The most interesting destinations
 ++ median
 sorter = Median(entries=>10)
 title = Sorted by Median Roundtrip Time
 menu = Top Median RTT
 format = Median RTT %e s

The following variables can be set in this section:

menu (mandatory setting): Menu entry for the Charts Section.
title (mandatory setting): Page title for the Charts Section.

The following sections are valid on level 2:

++/[-_0-9a-zA-Z]+/: The following variables can be set in this section:

menu (mandatory setting): Menu entry
title (mandatory setting): Page title
sorter (mandatory setting): sorter for this charts sections
format: sprintf format string to format current value

+multihost: Settings for the multihost graphs. At the moment this is only used for the color setting. Check the documentation on the host property of the target section for more.
The following variables can be set in this section:

colors: Space separated list of colors for multihost graphs
Example: colors = ff0000 00ff00 0000ff

+hierarchies: Provide an alternative presentation hierarchy for your smokeping data. After setting up a hierarchy in this section. You can use it in each target's parent property. A drop-down menu in the smokeping website lets the user switch presentation hierarchy.
The following sections are valid on level 2:

++/[-_0-9a-zA-Z]+/: Identifier of the hierarchies. Use this as prefix in the targets parent property
The following variables can be set in this section:

title (mandatory setting): Title for this hierarchy

* Probes * (mandatory section)

The Probes Section configures Probe modules. Probe modules integrate an external ping command into SmokePing. Check the documentation of each module for more information about it.

The following sections are valid on level 1:

+/[-_0-9a-zA-Z]+/

Each module can take specific configuration information from this area. The jumble of letters above is a regular expression defining legal module names.

See the documentation of each module for details about its variables.

The grammar of this section is dynamically modified based on its name.

The following sections are valid on level 2:

++/[-_0-9a-zA-Z]+/

You can define multiple instances of the same probe with subsections. These instances can have different values for their variables, so you can eg. have one instance of the FPing probe with packet size 1000 and step 300 and another instance with packet size 64 and step 30. The name of the subsection determines what the probe will be called, so you can write descriptive names for the probes.

If there are any subsections defined, the main section for this probe will just provide default parameter values for the probe instances, ie. it will not become a probe instance itself.

The example above would be written like this:

 *** Probes ***

 + FPing
 # this value is common for the two subprobes
 binary = /usr/bin/fping 

 ++ FPingLarge
 packetsize = 1000
 step = 300

 ++ FPingSmall
 packetsize = 64
 step = 30

Dynamical grammar changes for example instances of this section:

AnotherCurl: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary: see above
Default value: binary = /usr/bin/curl
forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
agent: (This variable can be overridden target-specifically in the Targets section.)
extraargs: (This variable can be overridden target-specifically in the Targets section.)
extrare: (This variable can be overridden target-specifically in the Targets section.)
Default value: extrare = / /
follow_redirects: (This variable can be overridden target-specifically in the Targets section.)
Default value: follow_redirects = no
include_redirects: (This variable can be overridden target-specifically in the Targets section.)
Default value: include_redirects = no
insecure_ssl: (This variable can be overridden target-specifically in the Targets section.)
interface: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
ssl2: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 10
urlformat: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
write_out: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/curl

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

agent

This variable inherits its value from the parent section if nothing is specified here.

extraargs

This variable inherits its value from the parent section if nothing is specified here.

extrare

This variable inherits its value from the parent section if nothing is specified here.

Default value: extrare = / /

follow_redirects

This variable inherits its value from the parent section if nothing is specified here.

Default value: follow_redirects = no

include_redirects

This variable inherits its value from the parent section if nothing is specified here.

Default value: include_redirects = no

insecure_ssl

This variable inherits its value from the parent section if nothing is specified here.

interface

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

ssl2

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 10

urlformat

This variable inherits its value from the parent section if nothing is specified here.

write_out

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "AnotherCurl".)

AnotherDNS: (See the separate module documentation for details about each variable.): The following new variables are valid:

forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
authoritative: (This variable can be overridden target-specifically in the Targets section.)
expect_text: (This variable can be overridden target-specifically in the Targets section.)
ipversion: (This variable can be overridden target-specifically in the Targets section.)
Default value: ipversion = 4
lookup: (This variable can be overridden target-specifically in the Targets section.)
mininterval: (This variable can be overridden target-specifically in the Targets section.)
Default value: mininterval = 0.5
pings: (This variable can be overridden target-specifically in the Targets section.)
port: (This variable can be overridden target-specifically in the Targets section.)
Default value: port = 53
protocol: (This variable can be overridden target-specifically in the Targets section.)
Default value: protocol = udp
recordtype: (This variable can be overridden target-specifically in the Targets section.)
Default value: recordtype = A
require_answers: (This variable can be overridden target-specifically in the Targets section.)
require_noerror: (This variable can be overridden target-specifically in the Targets section.)
require_nxdomain: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 5

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

authoritative

This variable inherits its value from the parent section if nothing is specified here.

expect_text

This variable inherits its value from the parent section if nothing is specified here.

ipversion

This variable inherits its value from the parent section if nothing is specified here.

Default value: ipversion = 4

lookup

This variable inherits its value from the parent section if nothing is specified here.

mininterval

This variable inherits its value from the parent section if nothing is specified here.

Default value: mininterval = 0.5

pings

This variable inherits its value from the parent section if nothing is specified here.

port

This variable inherits its value from the parent section if nothing is specified here.

Default value: port = 53

protocol

This variable inherits its value from the parent section if nothing is specified here.

Default value: protocol = udp

recordtype

This variable inherits its value from the parent section if nothing is specified here.

Default value: recordtype = A

require_answers

This variable inherits its value from the parent section if nothing is specified here.

require_noerror

This variable inherits its value from the parent section if nothing is specified here.

require_nxdomain

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

(End of dynamical grammar changes for example instance "AnotherDNS".)

AnotherSSH: (See the separate module documentation for details about each variable.): The following new variables are valid:

forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
greeting: (This variable can be overridden target-specifically in the Targets section.)
Default value: greeting = SSH-Latency-Measurement-Sorry-for-this-logmessage
interval: (This variable can be overridden target-specifically in the Targets section.)
Default value: interval = established
mininterval: (This variable can be overridden target-specifically in the Targets section.)
Default value: mininterval = 0.5
pings: (This variable can be overridden target-specifically in the Targets section.)
port: (This variable can be overridden target-specifically in the Targets section.)
Default value: port = 22
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 5

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

greeting

This variable inherits its value from the parent section if nothing is specified here.

Default value: greeting = SSH-Latency-Measurement-Sorry-for-this-logmessage

interval

This variable inherits its value from the parent section if nothing is specified here.

Default value: interval = established

mininterval

This variable inherits its value from the parent section if nothing is specified here.

Default value: mininterval = 0.5

pings

This variable inherits its value from the parent section if nothing is specified here.

port

This variable inherits its value from the parent section if nothing is specified here.

Default value: port = 22

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

(End of dynamical grammar changes for example instance "AnotherSSH".)

CiscoRTTMonDNS: (See the separate module documentation for details about each variable.): The following new variables are valid:

forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
ioshost: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
iosint: (This variable can be overridden target-specifically in the Targets section.)
name: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
pings: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 15

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

ioshost

This variable inherits its value from the parent section if nothing is specified here.

iosint

This variable inherits its value from the parent section if nothing is specified here.

name

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 15

(End of dynamical grammar changes for example instance "CiscoRTTMonDNS".)

CiscoRTTMonEchoICMP: (See the separate module documentation for details about each variable.): The following new variables are valid:

forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
ioshost: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
iosint: (This variable can be overridden target-specifically in the Targets section.)
packetsize: (This variable can be overridden target-specifically in the Targets section.)
Default value: packetsize = 56
pings: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 15
tos: (This variable can be overridden target-specifically in the Targets section.)
vrf: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

ioshost

This variable inherits its value from the parent section if nothing is specified here.

iosint

This variable inherits its value from the parent section if nothing is specified here.

packetsize

This variable inherits its value from the parent section if nothing is specified here.

Default value: packetsize = 56

pings

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 15

tos

This variable inherits its value from the parent section if nothing is specified here.

vrf

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "CiscoRTTMonEchoICMP".)

CiscoRTTMonTcpConnect: (See the separate module documentation for details about each variable.): The following new variables are valid:

forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
ioshost: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
iosint: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
port: (This variable can be overridden target-specifically in the Targets section.)
Default value: port = 80
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 15
tos: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

ioshost

This variable inherits its value from the parent section if nothing is specified here.

iosint

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

port

This variable inherits its value from the parent section if nothing is specified here.

Default value: port = 80

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 15

tos

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "CiscoRTTMonTcpConnect".)

Curl: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary: see above
Default value: binary = /usr/bin/curl
forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
agent: (This variable can be overridden target-specifically in the Targets section.)
expect: (This variable can be overridden target-specifically in the Targets section.)
extraargs: (This variable can be overridden target-specifically in the Targets section.)
extrare: (This variable can be overridden target-specifically in the Targets section.)
Default value: extrare = / /
follow_redirects: (This variable can be overridden target-specifically in the Targets section.)
Default value: follow_redirects = no
include_redirects: (This variable can be overridden target-specifically in the Targets section.)
Default value: include_redirects = no
insecure_ssl: (This variable can be overridden target-specifically in the Targets section.)
interface: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
require_zero_status: (This variable can be overridden target-specifically in the Targets section.)
Default value: require_zero_status = no
ssl2: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 10
urlformat: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/curl

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

agent

This variable inherits its value from the parent section if nothing is specified here.

expect

This variable inherits its value from the parent section if nothing is specified here.

extraargs

This variable inherits its value from the parent section if nothing is specified here.

extrare

This variable inherits its value from the parent section if nothing is specified here.

Default value: extrare = / /

follow_redirects

This variable inherits its value from the parent section if nothing is specified here.

Default value: follow_redirects = no

include_redirects

This variable inherits its value from the parent section if nothing is specified here.

Default value: include_redirects = no

insecure_ssl

This variable inherits its value from the parent section if nothing is specified here.

interface

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

require_zero_status

This variable inherits its value from the parent section if nothing is specified here.

Default value: require_zero_status = no

ssl2

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 10

urlformat

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "Curl".)

DNS: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary (mandatory setting): see above
forks: see above
Default value: forks = 5
offset: see above
step: see above
timeout: see above
Default value: timeout = 5
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
lookup: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
server: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

lookup

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

server

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "DNS".)

DismanPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

offset: see above
pings: see above
Default value: pings = 15
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
ownerindex: (This variable can be overridden target-specifically in the Targets section.)
packetsize: (This variable can be overridden target-specifically in the Targets section.)
Default value: packetsize = 56
pinghost: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
pingsrc: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

pings

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: pings = 15

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

ownerindex

This variable inherits its value from the parent section if nothing is specified here.

packetsize

This variable inherits its value from the parent section if nothing is specified here.

Default value: packetsize = 56

pinghost

This variable inherits its value from the parent section if nothing is specified here.

pingsrc

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "DismanPing".)

EchoPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary: see above
Default value: binary = /usr/bin/echoping
forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
extraopts: (This variable can be overridden target-specifically in the Targets section.)
fill: (This variable can be overridden target-specifically in the Targets section.)
ipversion: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
priority: (This variable can be overridden target-specifically in the Targets section.)
size: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 5
tos: (This variable can be overridden target-specifically in the Targets section.)
udp: (This variable can be overridden target-specifically in the Targets section.)
waittime: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/echoping

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

extraopts

This variable inherits its value from the parent section if nothing is specified here.

fill

This variable inherits its value from the parent section if nothing is specified here.

ipversion

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

priority

This variable inherits its value from the parent section if nothing is specified here.

size

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

tos

This variable inherits its value from the parent section if nothing is specified here.

udp

This variable inherits its value from the parent section if nothing is specified here.

waittime

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPing".)

EchoPingChargen: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary: see above
Default value: binary = /usr/bin/echoping
forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
extraopts: (This variable can be overridden target-specifically in the Targets section.)
fill: (This variable can be overridden target-specifically in the Targets section.)
ipversion: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
priority: (This variable can be overridden target-specifically in the Targets section.)
size: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 5
tos: (This variable can be overridden target-specifically in the Targets section.)
waittime: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/echoping

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

extraopts

This variable inherits its value from the parent section if nothing is specified here.

fill

This variable inherits its value from the parent section if nothing is specified here.

ipversion

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

priority

This variable inherits its value from the parent section if nothing is specified here.

size

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

tos

This variable inherits its value from the parent section if nothing is specified here.

waittime

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingChargen".)

EchoPingDNS: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary: see above
Default value: binary = /usr/bin/echoping
forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
dns_request: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
dns_tcp: (This variable can be overridden target-specifically in the Targets section.)
dns_type: (This variable can be overridden target-specifically in the Targets section.)
Default value: dns_type = A
extraopts: (This variable can be overridden target-specifically in the Targets section.)
ipversion: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
plugin: (This variable can be overridden target-specifically in the Targets section.)
Default value: plugin = dns
pluginargs: (This variable can be overridden target-specifically in the Targets section.)
priority: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 5
tos: (This variable can be overridden target-specifically in the Targets section.)
waittime: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/echoping

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

dns_request

This variable inherits its value from the parent section if nothing is specified here.

dns_tcp

This variable inherits its value from the parent section if nothing is specified here.

dns_type

This variable inherits its value from the parent section if nothing is specified here.

Default value: dns_type = A

extraopts

This variable inherits its value from the parent section if nothing is specified here.

ipversion

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

plugin

This variable inherits its value from the parent section if nothing is specified here.

Default value: plugin = dns

pluginargs

This variable inherits its value from the parent section if nothing is specified here.

priority

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

tos

This variable inherits its value from the parent section if nothing is specified here.

waittime

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingDNS".)

EchoPingDiscard: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary: see above
Default value: binary = /usr/bin/echoping
forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
extraopts: (This variable can be overridden target-specifically in the Targets section.)
fill: (This variable can be overridden target-specifically in the Targets section.)
ipversion: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
priority: (This variable can be overridden target-specifically in the Targets section.)
size: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 5
tos: (This variable can be overridden target-specifically in the Targets section.)
udp: (This variable can be overridden target-specifically in the Targets section.)
waittime: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/echoping

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

extraopts

This variable inherits its value from the parent section if nothing is specified here.

fill

This variable inherits its value from the parent section if nothing is specified here.

ipversion

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

priority

This variable inherits its value from the parent section if nothing is specified here.

size

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

tos

This variable inherits its value from the parent section if nothing is specified here.

udp

This variable inherits its value from the parent section if nothing is specified here.

waittime

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingDiscard".)

EchoPingHttp: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary: see above
Default value: binary = /usr/bin/echoping
forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
accept_redirects: (This variable can be overridden target-specifically in the Targets section.)
extraopts: (This variable can be overridden target-specifically in the Targets section.)
ignore_cache: (This variable can be overridden target-specifically in the Targets section.)
ipversion: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
port: (This variable can be overridden target-specifically in the Targets section.)
priority: (This variable can be overridden target-specifically in the Targets section.)
revalidate_data: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 10
tos: (This variable can be overridden target-specifically in the Targets section.)
url: (This variable can be overridden target-specifically in the Targets section.)
Default value: url = /
waittime: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/echoping

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

accept_redirects

This variable inherits its value from the parent section if nothing is specified here.

extraopts

This variable inherits its value from the parent section if nothing is specified here.

ignore_cache

This variable inherits its value from the parent section if nothing is specified here.

ipversion

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

port

This variable inherits its value from the parent section if nothing is specified here.

priority

This variable inherits its value from the parent section if nothing is specified here.

revalidate_data

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 10

tos

This variable inherits its value from the parent section if nothing is specified here.

url

This variable inherits its value from the parent section if nothing is specified here.

Default value: url = /

waittime

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingHttp".)

EchoPingHttps: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary: see above
Default value: binary = /usr/bin/echoping
forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
accept_redirects: (This variable can be overridden target-specifically in the Targets section.)
extraopts: (This variable can be overridden target-specifically in the Targets section.)
ignore_cache: (This variable can be overridden target-specifically in the Targets section.)
ipversion: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
port: (This variable can be overridden target-specifically in the Targets section.)
priority: (This variable can be overridden target-specifically in the Targets section.)
prot: (This variable can be overridden target-specifically in the Targets section.)
Default value: prot = 443
revalidate_data: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 10
tos: (This variable can be overridden target-specifically in the Targets section.)
url: (This variable can be overridden target-specifically in the Targets section.)
Default value: url = /
waittime: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/echoping

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

accept_redirects

This variable inherits its value from the parent section if nothing is specified here.

extraopts

This variable inherits its value from the parent section if nothing is specified here.

ignore_cache

This variable inherits its value from the parent section if nothing is specified here.

ipversion

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

port

This variable inherits its value from the parent section if nothing is specified here.

priority

This variable inherits its value from the parent section if nothing is specified here.

prot

This variable inherits its value from the parent section if nothing is specified here.

Default value: prot = 443

revalidate_data

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 10

tos

This variable inherits its value from the parent section if nothing is specified here.

url

This variable inherits its value from the parent section if nothing is specified here.

Default value: url = /

waittime

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingHttps".)

EchoPingIcp: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary: see above
Default value: binary = /usr/bin/echoping
forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
extraopts: (This variable can be overridden target-specifically in the Targets section.)
ipversion: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
priority: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 5
tos: (This variable can be overridden target-specifically in the Targets section.)
url: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
waittime: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/echoping

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

extraopts

This variable inherits its value from the parent section if nothing is specified here.

ipversion

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

priority

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

tos

This variable inherits its value from the parent section if nothing is specified here.

url

This variable inherits its value from the parent section if nothing is specified here.

waittime

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingIcp".)

EchoPingLDAP: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary: see above
Default value: binary = /usr/bin/echoping
forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
extraopts: (This variable can be overridden target-specifically in the Targets section.)
ipversion: (This variable can be overridden target-specifically in the Targets section.)
ldap_base: (This variable can be overridden target-specifically in the Targets section.)
ldap_request: (This variable can be overridden target-specifically in the Targets section.)
ldap_scope: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
plugin: (This variable can be overridden target-specifically in the Targets section.)
Default value: plugin = ldap
pluginargs: (This variable can be overridden target-specifically in the Targets section.)
priority: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 5
tos: (This variable can be overridden target-specifically in the Targets section.)
waittime: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/echoping

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

extraopts

This variable inherits its value from the parent section if nothing is specified here.

ipversion

This variable inherits its value from the parent section if nothing is specified here.

ldap_base

This variable inherits its value from the parent section if nothing is specified here.

ldap_request

This variable inherits its value from the parent section if nothing is specified here.

ldap_scope

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

plugin

This variable inherits its value from the parent section if nothing is specified here.

Default value: plugin = ldap

pluginargs

This variable inherits its value from the parent section if nothing is specified here.

priority

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

tos

This variable inherits its value from the parent section if nothing is specified here.

waittime

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingLDAP".)

EchoPingPlugin: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary: see above
Default value: binary = /usr/bin/echoping
forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
extraopts: (This variable can be overridden target-specifically in the Targets section.)
ipversion: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
plugin: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
pluginargs: (This variable can be overridden target-specifically in the Targets section.)
priority: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 5
tos: (This variable can be overridden target-specifically in the Targets section.)
waittime: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/echoping

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

extraopts

This variable inherits its value from the parent section if nothing is specified here.

ipversion

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

plugin

This variable inherits its value from the parent section if nothing is specified here.

pluginargs

This variable inherits its value from the parent section if nothing is specified here.

priority

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

tos

This variable inherits its value from the parent section if nothing is specified here.

waittime

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingPlugin".)

EchoPingSmtp: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary: see above
Default value: binary = /usr/bin/echoping
forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
extraopts: (This variable can be overridden target-specifically in the Targets section.)
ipversion: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
priority: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 5
tos: (This variable can be overridden target-specifically in the Targets section.)
waittime: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/echoping

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

extraopts

This variable inherits its value from the parent section if nothing is specified here.

ipversion

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

priority

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

tos

This variable inherits its value from the parent section if nothing is specified here.

waittime

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingSmtp".)

EchoPingWhois: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary: see above
Default value: binary = /usr/bin/echoping
forks: see above
Default value: forks = 5
offset: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
extraopts: (This variable can be overridden target-specifically in the Targets section.)
ipversion: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
plugin: (This variable can be overridden target-specifically in the Targets section.)
Default value: plugin = whois
pluginargs: (This variable can be overridden target-specifically in the Targets section.)
priority: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 5
tos: (This variable can be overridden target-specifically in the Targets section.)
waittime: (This variable can be overridden target-specifically in the Targets section.)
whois_request: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/echoping

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

extraopts

This variable inherits its value from the parent section if nothing is specified here.

ipversion

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

plugin

This variable inherits its value from the parent section if nothing is specified here.

Default value: plugin = whois

pluginargs

This variable inherits its value from the parent section if nothing is specified here.

priority

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

tos

This variable inherits its value from the parent section if nothing is specified here.

waittime

This variable inherits its value from the parent section if nothing is specified here.

whois_request

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "EchoPingWhois".)

FPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary (mandatory setting): see above
blazemode: see above
hostinterval: see above
interface: see above
mininterval: see above
Default value: mininterval = 0.01
offset: see above
packetsize: see above
pings: see above
protocol: see above
sourceaddress: see above
step: see above
timeout: see above
tos: see above
usestdout: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

blazemode

see above

This variable inherits its value from the parent section if nothing is specified here.

hostinterval

see above

This variable inherits its value from the parent section if nothing is specified here.

interface

see above

This variable inherits its value from the parent section if nothing is specified here.

mininterval

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: mininterval = 0.01

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

packetsize

see above

This variable inherits its value from the parent section if nothing is specified here.

pings

see above

This variable inherits its value from the parent section if nothing is specified here.

protocol

see above

This variable inherits its value from the parent section if nothing is specified here.

sourceaddress

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

tos

see above

This variable inherits its value from the parent section if nothing is specified here.

usestdout

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "FPing".)

FPing6: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary (mandatory setting): see above
blazemode: see above
hostinterval: see above
interface: see above
mininterval: see above
Default value: mininterval = 0.01
offset: see above
packetsize: see above
pings: see above
protocol: see above
Default value: protocol = 6
sourceaddress: see above
step: see above
timeout: see above
tos: see above
usestdout: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

blazemode

see above

This variable inherits its value from the parent section if nothing is specified here.

hostinterval

see above

This variable inherits its value from the parent section if nothing is specified here.

interface

see above

This variable inherits its value from the parent section if nothing is specified here.

mininterval

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: mininterval = 0.01

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

packetsize

see above

This variable inherits its value from the parent section if nothing is specified here.

pings

see above

This variable inherits its value from the parent section if nothing is specified here.

protocol

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: protocol = 6

sourceaddress

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

tos

see above

This variable inherits its value from the parent section if nothing is specified here.

usestdout

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "FPing6".)

FPingContinuous: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary (mandatory setting): see above
hostinterval: see above
offset: see above
packetsize: see above
pings: see above
sourceaddress: see above
step: see above
timeout: see above
tos: see above
usestdout: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary (mandatory setting): see above
This variable inherits its value from the parent section if nothing is specified here.
hostinterval: see above
This variable inherits its value from the parent section if nothing is specified here.
offset: see above
This variable inherits its value from the parent section if nothing is specified here.
packetsize: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
sourceaddress: see above
This variable inherits its value from the parent section if nothing is specified here.
step: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
tos: see above
This variable inherits its value from the parent section if nothing is specified here.
usestdout: see above
This variable inherits its value from the parent section if nothing is specified here.
/^influx_.+/: This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "FPingContinuous".)

FTPtransfer: (See the separate module documentation for details about each variable.): The following new variables are valid:

destfile: see above
forks: see above
Default value: forks = 5
min_interval: see above
Default value: min_interval = 1
mode (mandatory setting): see above
offset: see above
passwordfile: see above
srcfile (mandatory setting): see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
localaddr: (This variable can be overridden target-specifically in the Targets section.)
passive: (This variable can be overridden target-specifically in the Targets section.)
password: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
port: (This variable can be overridden target-specifically in the Targets section.)
timeout (mandatory setting): (This variable can be overridden target-specifically in the Targets section.)
username: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

destfile

see above

This variable inherits its value from the parent section if nothing is specified here.

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

min_interval

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: min_interval = 1

mode (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

passwordfile

see above

This variable inherits its value from the parent section if nothing is specified here.

srcfile (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

localaddr

This variable inherits its value from the parent section if nothing is specified here.

passive

This variable inherits its value from the parent section if nothing is specified here.

password

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

port

This variable inherits its value from the parent section if nothing is specified here.

timeout (mandatory setting)

This variable inherits its value from the parent section if nothing is specified here.

username

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "FTPtransfer".)

IOSPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary (mandatory setting): see above
forks: see above
Default value: forks = 5
offset: see above
packetsize: see above
Default value: packetsize = 56
step: see above
timeout: see above
Default value: timeout = 5
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
ioshost: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
iosint: (This variable can be overridden target-specifically in the Targets section.)
iosuser: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

packetsize

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: packetsize = 56

step

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

ioshost

This variable inherits its value from the parent section if nothing is specified here.

iosint

This variable inherits its value from the parent section if nothing is specified here.

iosuser

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "IOSPing".)

IRTT: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary (mandatory setting): see above
Default value: binary = /usr/bin/irtt
forks: see above
Default value: forks = 5
offset: see above
step: see above
timeout: see above
Default value: timeout = 5
tmpdir: see above
Default value: tmpdir = /tmp/smokeping-irtt
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
dscp: (This variable can be overridden target-specifically in the Targets section.)
extraargs: (This variable can be overridden target-specifically in the Targets section.)
fill: (This variable can be overridden target-specifically in the Targets section.)
hmac: (This variable can be overridden target-specifically in the Targets section.)
interval: (This variable can be overridden target-specifically in the Targets section.)
Default value: interval = 1
ipversion: (This variable can be overridden target-specifically in the Targets section.)
length: (This variable can be overridden target-specifically in the Targets section.)
localaddr: (This variable can be overridden target-specifically in the Targets section.)
metric: (This variable can be overridden target-specifically in the Targets section.)
Default value: metric = rtt
pings: (This variable can be overridden target-specifically in the Targets section.)
readfrom: (This variable can be overridden target-specifically in the Targets section.)
readfrompollinterval: (This variable can be overridden target-specifically in the Targets section.)
Default value: readfrompollinterval = 5
serverfill: (This variable can be overridden target-specifically in the Targets section.)
sleep: (This variable can be overridden target-specifically in the Targets section.)
writeto: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/irtt

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

tmpdir

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: tmpdir = /tmp/smokeping-irtt

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

dscp

This variable inherits its value from the parent section if nothing is specified here.

extraargs

This variable inherits its value from the parent section if nothing is specified here.

fill

This variable inherits its value from the parent section if nothing is specified here.

hmac

This variable inherits its value from the parent section if nothing is specified here.

interval

This variable inherits its value from the parent section if nothing is specified here.

Default value: interval = 1

ipversion

This variable inherits its value from the parent section if nothing is specified here.

length

This variable inherits its value from the parent section if nothing is specified here.

localaddr

This variable inherits its value from the parent section if nothing is specified here.

metric

This variable inherits its value from the parent section if nothing is specified here.

Default value: metric = rtt

pings

This variable inherits its value from the parent section if nothing is specified here.

readfrom

This variable inherits its value from the parent section if nothing is specified here.

readfrompollinterval

This variable inherits its value from the parent section if nothing is specified here.

Default value: readfrompollinterval = 5

serverfill

This variable inherits its value from the parent section if nothing is specified here.

sleep

This variable inherits its value from the parent section if nothing is specified here.

writeto

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "IRTT".)

LDAP: (See the separate module documentation for details about each variable.): The following new variables are valid:

forks: see above
Default value: forks = 5
offset: see above
passwordfile: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
attrs: (This variable can be overridden target-specifically in the Targets section.)
base: (This variable can be overridden target-specifically in the Targets section.)
binddn: (This variable can be overridden target-specifically in the Targets section.)
filter: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
mininterval: (This variable can be overridden target-specifically in the Targets section.)
Default value: mininterval = 1
password: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
port: (This variable can be overridden target-specifically in the Targets section.)
scheme: (This variable can be overridden target-specifically in the Targets section.)
Default value: scheme = ldap
scope: (This variable can be overridden target-specifically in the Targets section.)
Default value: scope = sub
start_tls: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 5
verify: (This variable can be overridden target-specifically in the Targets section.)
Default value: verify = require
version: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

passwordfile

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

attrs

This variable inherits its value from the parent section if nothing is specified here.

base

This variable inherits its value from the parent section if nothing is specified here.

binddn

This variable inherits its value from the parent section if nothing is specified here.

filter

This variable inherits its value from the parent section if nothing is specified here.

mininterval

This variable inherits its value from the parent section if nothing is specified here.

Default value: mininterval = 1

password

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

port

This variable inherits its value from the parent section if nothing is specified here.

scheme

This variable inherits its value from the parent section if nothing is specified here.

Default value: scheme = ldap

scope

This variable inherits its value from the parent section if nothing is specified here.

Default value: scope = sub

start_tls

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

verify

This variable inherits its value from the parent section if nothing is specified here.

Default value: verify = require

version

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "LDAP".)

NFSping: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary (mandatory setting): see above
blazemode: see above
hostinterval: see above
mininterval: see above
Default value: mininterval = 0.01
offset: see above
pings: see above
step: see above
tcp: see above
timeout: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

blazemode

see above

This variable inherits its value from the parent section if nothing is specified here.

hostinterval

see above

This variable inherits its value from the parent section if nothing is specified here.

mininterval

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: mininterval = 0.01

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

pings

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

tcp

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "NFSping".)

OpenSSHEOSPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

forks: see above
Default value: forks = 5
offset: see above
packetsize: see above
Default value: packetsize = 100
step: see above
timeout: see above
Default value: timeout = 5
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
eospass: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
eosuser: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
pings: (This variable can be overridden target-specifically in the Targets section.)
psource: (This variable can be overridden target-specifically in the Targets section.)
source: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
unpriv: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

packetsize

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: packetsize = 100

step

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

eospass

This variable inherits its value from the parent section if nothing is specified here.

eosuser

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

psource

This variable inherits its value from the parent section if nothing is specified here.

source

This variable inherits its value from the parent section if nothing is specified here.

unpriv

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "OpenSSHEOSPing".)

OpenSSHJunOSPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

forks: see above
Default value: forks = 5
offset: see above
packetsize: see above
Default value: packetsize = 100
step: see above
timeout: see above
Default value: timeout = 5
tos: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
junospass: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
junosuser: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
pings: (This variable can be overridden target-specifically in the Targets section.)
psource: (This variable can be overridden target-specifically in the Targets section.)
source: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

packetsize

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: packetsize = 100

step

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

tos

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

junospass

This variable inherits its value from the parent section if nothing is specified here.

junosuser

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

psource

This variable inherits its value from the parent section if nothing is specified here.

source

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "OpenSSHJunOSPing".)

Qstat: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary (mandatory setting): see above
forks: see above
Default value: forks = 5
game: see above
Default value: game = q3s
mininterval: see above
Default value: mininterval = 0.5
offset: see above
port: see above
sourceaddress: see above
sourceport: see above
step: see above
timeout: see above
Default value: timeout = 5
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

game

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: game = q3s

mininterval

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: mininterval = 0.5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

port

see above

This variable inherits its value from the parent section if nothing is specified here.

sourceaddress

see above

This variable inherits its value from the parent section if nothing is specified here.

sourceport

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "Qstat".)

Radius: (See the separate module documentation for details about each variable.): The following new variables are valid:

forks: see above
Default value: forks = 5
offset: see above
passwordfile: see above
secretfile: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
allowreject: (This variable can be overridden target-specifically in the Targets section.)
mininterval: (This variable can be overridden target-specifically in the Targets section.)
Default value: mininterval = 1
nas_ip_address: (This variable can be overridden target-specifically in the Targets section.)
password: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
port: (This variable can be overridden target-specifically in the Targets section.)
secret: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 5
username: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

passwordfile

see above

This variable inherits its value from the parent section if nothing is specified here.

secretfile

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

allowreject

This variable inherits its value from the parent section if nothing is specified here.

mininterval

This variable inherits its value from the parent section if nothing is specified here.

Default value: mininterval = 1

nas_ip_address

This variable inherits its value from the parent section if nothing is specified here.

password

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

port

This variable inherits its value from the parent section if nothing is specified here.

secret

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

username

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "Radius".)

RemoteFPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary (mandatory setting): see above
blazemode: see above
hostinterval: see above
interface: see above
mininterval: see above
Default value: mininterval = 0.01
offset: see above
packetsize: see above
pings: see above
protocol: see above
rbinary (mandatory setting): see above
rhost (mandatory setting): see above
rport: see above
ruser: see above
sourceaddress: see above
step: see above
timeout: see above
tos: see above
usestdout: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

blazemode

see above

This variable inherits its value from the parent section if nothing is specified here.

hostinterval

see above

This variable inherits its value from the parent section if nothing is specified here.

interface

see above

This variable inherits its value from the parent section if nothing is specified here.

mininterval

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: mininterval = 0.01

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

packetsize

see above

This variable inherits its value from the parent section if nothing is specified here.

pings

see above

This variable inherits its value from the parent section if nothing is specified here.

protocol

see above

This variable inherits its value from the parent section if nothing is specified here.

rbinary (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

rhost (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

rport

see above

This variable inherits its value from the parent section if nothing is specified here.

ruser

see above

This variable inherits its value from the parent section if nothing is specified here.

sourceaddress

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

tos

see above

This variable inherits its value from the parent section if nothing is specified here.

usestdout

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "RemoteFPing".)

SSH: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary (mandatory setting): see above
forks: see above
Default value: forks = 5
offset: see above
step: see above
timeout: see above
Default value: timeout = 5
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
keytype: (This variable can be overridden target-specifically in the Targets section.)
Default value: keytype = rsa
pings: (This variable can be overridden target-specifically in the Targets section.)
port: (This variable can be overridden target-specifically in the Targets section.)
Default value: port = 22

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

keytype

This variable inherits its value from the parent section if nothing is specified here.

Default value: keytype = rsa

pings

This variable inherits its value from the parent section if nothing is specified here.

port

This variable inherits its value from the parent section if nothing is specified here.

Default value: port = 22

(End of dynamical grammar changes for example instance "SSH".)

SendEmail: (See the separate module documentation for details about each variable.): The following new variables are valid:

bodysize: see above
forks: see above
Default value: forks = 5
from (mandatory setting): see above
offset: see above
step: see above
subject: see above
Default value: subject = Test
timeout: see above
Default value: timeout = 5
to (mandatory setting): see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
port: (This variable can be overridden target-specifically in the Targets section.)
Default value: port = 25

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

bodysize

see above

This variable inherits its value from the parent section if nothing is specified here.

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

from (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

subject

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: subject = Test

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

to (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

port

This variable inherits its value from the parent section if nothing is specified here.

Default value: port = 25

(End of dynamical grammar changes for example instance "SendEmail".)

SipSak: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary: see above
Default value: binary = /usr/bin/sipsak
forks: see above
Default value: forks = 5
offset: see above
step: see above
timeout: see above
Default value: timeout = 5
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
keep_second: (This variable can be overridden target-specifically in the Targets section.)
params: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
port: (This variable can be overridden target-specifically in the Targets section.)
sipsak_timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: sipsak_timeout = 2
user: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: binary = /usr/bin/sipsak

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

keep_second

This variable inherits its value from the parent section if nothing is specified here.

params

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

port

This variable inherits its value from the parent section if nothing is specified here.

sipsak_timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: sipsak_timeout = 2

user

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "SipSak".)

TCPPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary (mandatory setting): see above
forks: see above
Default value: forks = 5
offset: see above
step: see above
timeout: see above
Default value: timeout = 5
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
port: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

port

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "TCPPing".)

TacacsPlus: (See the separate module documentation for details about each variable.): The following new variables are valid:

forks: see above
Default value: forks = 5
offset: see above
passwordfile: see above
secretfile: see above
step: see above
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
authtype: (This variable can be overridden target-specifically in the Targets section.)
Default value: authtype = ASCII
mininterval: (This variable can be overridden target-specifically in the Targets section.)
Default value: mininterval = 1
password: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
port: (This variable can be overridden target-specifically in the Targets section.)
Default value: port = 49
secret: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 5
username: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

passwordfile

see above

This variable inherits its value from the parent section if nothing is specified here.

secretfile

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

authtype

This variable inherits its value from the parent section if nothing is specified here.

Default value: authtype = ASCII

mininterval

This variable inherits its value from the parent section if nothing is specified here.

Default value: mininterval = 1

password

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

port

This variable inherits its value from the parent section if nothing is specified here.

Default value: port = 49

secret

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

username

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "TacacsPlus".)

TelnetIOSPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

forks: see above
Default value: forks = 5
offset: see above
packetsize: see above
Default value: packetsize = 56
step: see above
timeout: see above
Default value: timeout = 5
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
iospass: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
iosuser: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
pings: (This variable can be overridden target-specifically in the Targets section.)
psource: (This variable can be overridden target-specifically in the Targets section.)
source: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
vrf: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

packetsize

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: packetsize = 56

step

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

iospass

This variable inherits its value from the parent section if nothing is specified here.

iosuser

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

psource

This variable inherits its value from the parent section if nothing is specified here.

source

This variable inherits its value from the parent section if nothing is specified here.

vrf

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "TelnetIOSPing".)

TelnetJunOSPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

forks: see above
Default value: forks = 5
offset: see above
packetsize: see above
Default value: packetsize = 100
step: see above
timeout: see above
Default value: timeout = 5
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
junospass: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
junosuser: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
pings: (This variable can be overridden target-specifically in the Targets section.)
psource: (This variable can be overridden target-specifically in the Targets section.)
source: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

packetsize

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: packetsize = 100

step

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

junospass

This variable inherits its value from the parent section if nothing is specified here.

junosuser

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

psource

This variable inherits its value from the parent section if nothing is specified here.

source

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "TelnetJunOSPing".)

TraceroutePing: (See the separate module documentation for details about each variable.): The following new variables are valid:

binary (mandatory setting): see above
binaryv6: see above
forks: see above
Default value: forks = 5
offset: see above
step: see above
timeout: see above
Default value: timeout = 5
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
desthost: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
host: (This variable can be overridden target-specifically in the Targets section.)
This variable dynamically modifies the grammar based on its value.
maxttl: (This variable can be overridden target-specifically in the Targets section.)
minttl: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
wait: (This variable can be overridden target-specifically in the Targets section.)

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

binary (mandatory setting)

see above

This variable inherits its value from the parent section if nothing is specified here.

binaryv6

see above

This variable inherits its value from the parent section if nothing is specified here.

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

timeout

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 5

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

desthost

This variable inherits its value from the parent section if nothing is specified here.

host

This variable inherits its value from the parent section if nothing is specified here.

maxttl

This variable inherits its value from the parent section if nothing is specified here.

minttl

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

wait

This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for example instance "TraceroutePing".)

WebProxyFilter: (See the separate module documentation for details about each variable.): The following new variables are valid:

forks: see above
Default value: forks = 5
maxsize: see above
Default value: maxsize = 2000
min_interval: see above
Default value: min_interval = 1
offset: see above
step: see above
useragent: see above
Default value: useragent = SmokePing/2.x (WebProxyFilter Probe)
/^influx_.+/: (This variable can be overridden target-specifically in the Targets section.)
deny_re (mandatory setting): (This variable can be overridden target-specifically in the Targets section.)
more_hosts: (This variable can be overridden target-specifically in the Targets section.)
pings: (This variable can be overridden target-specifically in the Targets section.)
timeout: (This variable can be overridden target-specifically in the Targets section.)
Default value: timeout = 2

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

forks

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: forks = 5

maxsize

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: maxsize = 2000

min_interval

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: min_interval = 1

offset

see above

This variable inherits its value from the parent section if nothing is specified here.

step

see above

This variable inherits its value from the parent section if nothing is specified here.

useragent

see above

This variable inherits its value from the parent section if nothing is specified here.

Default value: useragent = SmokePing/2.x (WebProxyFilter Probe)

/^influx_.+/

This variable inherits its value from the parent section if nothing is specified here.

deny_re (mandatory setting)

This variable inherits its value from the parent section if nothing is specified here.

more_hosts

This variable inherits its value from the parent section if nothing is specified here.

pings

This variable inherits its value from the parent section if nothing is specified here.

timeout

This variable inherits its value from the parent section if nothing is specified here.

Default value: timeout = 2

(End of dynamical grammar changes for example instance "WebProxyFilter".)

(End of dynamical grammar changes for example instances of section "/[-_0-9a-zA-Z]+/".)

* Targets * (mandatory section)

The Target Section defines the actual work of SmokePing. It contains a hierarchical list of hosts which mark the endpoints of the network connections the system should monitor. Each section can contain one host as well as other sections. By adding slaves you can measure the connection to an endpoint from multiple locations.

The following variables can be set in this section:

probe (mandatory setting): The name of the probe module to be used for this host. The value of this variable gets propagated
This variable dynamically modifies the grammar based on its value.
menu (mandatory setting): Menu entry for this section. If not set this will be set to the hostname.
title (mandatory setting): Title of the page when it is displayed. This will be set to the hostname if left empty.
remark: An optional remark on the current section. It gets displayed on the webpage.
alerts: A comma separated list of alerts to check for this target. The alerts have to be setup in the Alerts section. Alerts are inherited by child nodes. Use an empty alerts definition to remove inherited alerts from the current target and its children.
slaves: List of slave servers. It gets inherited by all targets.
menuextra: HTML String to be added to the end of each menu entry. The "{HOST}" entry will be replaced by the host property of the relevant section. The "{CLASS}" entry will be replaced by the same class as the other tags in the manu line.
parents

The following sections are valid on level 1:

+/[-_0-9a-zA-Z]+/

Each target section can contain information about a host to monitor as well as further target sections. Most variables have already been described above. The expression above defines legal names for target sections.

This section is recursive: it can contain subsection(s) with the same syntax.

The following variables can be set in this section:

probe: This variable inherits its value from the parent section if nothing is specified here.
This variable dynamically modifies the grammar based on its value.
menu
title
alerts: Comma separated list of alert names
This variable inherits its value from the parent section if nothing is specified here.
note: Some information about this entry which does NOT get displayed on the web.
email: This is the contact address for the owner of the current host. In connection with the DYNAMIC hosts, the address will be used for sending the belowmentioned script.
host: There are three types of "hosts" in smokeping.

1.

The 'hostname' is a name of a host you want to target from smokeping

2.

The string DYNAMIC. Is for machines that have a dynamic IP address. These boxes are required to regularly contact the SmokePing server to confirm their IP address. When starting SmokePing with the commandline argument --email it will add a secret password to each of the DYNAMIC host lines and send a script to the owner of each host. This script must be started periodically (cron) on the host in question to let smokeping know where the host is currently located. If the target machine supports SNMP SmokePing will also query the hosts sysContact, sysName and sysLocation properties to make sure it is still the same host.

3.

A space separated list of 'target-path' entries (multihost target). All targets mentioned in this list will be displayed in one graph. Note that the graph will look different from the normal smokeping graphs. The syntax for multihost targets is as follows:

 host = /world/town/host1 /world/town2/host33 /world/town2/host1~slave

remark

rawlog

Log the raw data, gathered for this target, in tab separated format, to a file with the same basename as the corresponding RRD file. Use posix strftime to format the timestamp to be put into the file name. The filename is built like this:

 basename.strftime.csv

Example:

 rawlog=%Y-%m-%d

this would create a new logfile every day with a name like this:

 targethost.2004-05-03.csv

alertee

If you want to have alerts for this target and all targets below it go to a particular address on top of the address already specified in the alert, you can add it here. This can be a comma separated list of items.

This variable inherits its value from the parent section if nothing is specified here.

slaves

The slave names must match the slaves you have setup in the slaves section.

This variable inherits its value from the parent section if nothing is specified here.

menuextra

HTML String to be added to the end of each menu entry. The following tags will be replaced:

  {HOST}     -> #$hostname
  {HOSTNAME} -> $hostname
  {CLASS}    -> same class as the other tags in the menu line
  {HASH}     -> #

This variable inherits its value from the parent section if nothing is specified here.

parents

After setting up a hierarchy in the Presentation section of the configuration file you can use this property to assign an entry to alternate hierarchies. The format for parent entries is.

 hierarchyA:/Node1/Node2 hierarchyB:/Node3

The entries from all parent properties together will build a new tree for each hierarchy. With this method it is possible to make a single target show up multiple times in a tree. If you think this is a good thing, go ahead, nothing is stopping you. Since you do not only define the parent but the full path of the parent node, circular dependencies are not possible.

hide

Set the hide property to 'yes' to hide this host from the navigation menu and from search results. Note that if you set the hide property on a non leaf entry all subordinate entries will also disappear in the menu structure. If you know a direct link to a page it is still accessible. Pages which are hidden from the menu due to a parent being hidden will still show up in search results and in alternate hierarchies where they are below a non hidden parent.

Default value: hide = no

nomasterpoll

Use this in a master/slave setup where the master must not poll a particular target. The master will now skip this entry in its polling cycle. Note that if you set the hide property on a non leaf entry all subordinate entries will also disappear in the menu structure. You can still access them via direct link or via an alternate hierarchy.

If you have no master/slave setup this will have a similar effect to the hide property, except that the menu entry will still show up, but will not contain any graphs.

This variable inherits its value from the parent section if nothing is specified here.

Default value: nomasterpoll = no

The following sections are valid on level 2:

++/[-_0-9a-zA-Z]+/: This section is recursive: it can contain subsection(s) with the same syntax.

Dynamical grammar changes for example values of variable "probe":

AnotherCurl: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
agent: see above
extraargs: see above
extrare: see above
follow_redirects: see above
include_redirects: see above
insecure_ssl: see above
interface: see above
pings: see above
ssl2: see above
timeout: see above
urlformat: see above
write_out: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
agent: see above
This variable inherits its value from the parent section if nothing is specified here.
extraargs: see above
This variable inherits its value from the parent section if nothing is specified here.
extrare: see above
This variable inherits its value from the parent section if nothing is specified here.
follow_redirects: see above
This variable inherits its value from the parent section if nothing is specified here.
include_redirects: see above
This variable inherits its value from the parent section if nothing is specified here.
insecure_ssl: see above
This variable inherits its value from the parent section if nothing is specified here.
interface: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
ssl2: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
urlformat: see above
This variable inherits its value from the parent section if nothing is specified here.
write_out: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "AnotherCurl".)

AnotherDNS: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
authoritative: see above
expect_text: see above
ipversion: see above
lookup: see above
mininterval: see above
pings: see above
port: see above
protocol: see above
recordtype: see above
require_answers: see above
require_noerror: see above
require_nxdomain: see above
timeout: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
authoritative: see above
This variable inherits its value from the parent section if nothing is specified here.
expect_text: see above
This variable inherits its value from the parent section if nothing is specified here.
ipversion: see above
This variable inherits its value from the parent section if nothing is specified here.
lookup: see above
This variable inherits its value from the parent section if nothing is specified here.
mininterval: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
port: see above
This variable inherits its value from the parent section if nothing is specified here.
protocol: see above
This variable inherits its value from the parent section if nothing is specified here.
recordtype: see above
This variable inherits its value from the parent section if nothing is specified here.
require_answers: see above
This variable inherits its value from the parent section if nothing is specified here.
require_noerror: see above
This variable inherits its value from the parent section if nothing is specified here.
require_nxdomain: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "AnotherDNS".)

AnotherSSH: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
greeting: see above
interval: see above
mininterval: see above
pings: see above
port: see above
timeout: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
greeting: see above
This variable inherits its value from the parent section if nothing is specified here.
interval: see above
This variable inherits its value from the parent section if nothing is specified here.
mininterval: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
port: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "AnotherSSH".)

CiscoRTTMonDNS: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
ioshost: see above
iosint: see above
name: see above
pings: see above
timeout: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
ioshost: see above
This variable inherits its value from the parent section if nothing is specified here.
iosint: see above
This variable inherits its value from the parent section if nothing is specified here.
name: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "CiscoRTTMonDNS".)

CiscoRTTMonEchoICMP: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
ioshost: see above
iosint: see above
packetsize: see above
pings: see above
timeout: see above
tos: see above
vrf: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
ioshost: see above
This variable inherits its value from the parent section if nothing is specified here.
iosint: see above
This variable inherits its value from the parent section if nothing is specified here.
packetsize: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
tos: see above
This variable inherits its value from the parent section if nothing is specified here.
vrf: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "CiscoRTTMonEchoICMP".)

CiscoRTTMonTcpConnect: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
ioshost: see above
iosint: see above
pings: see above
port: see above
timeout: see above
tos: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
ioshost: see above
This variable inherits its value from the parent section if nothing is specified here.
iosint: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
port: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
tos: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "CiscoRTTMonTcpConnect".)

Curl: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
agent: see above
expect: see above
extraargs: see above
extrare: see above
follow_redirects: see above
include_redirects: see above
insecure_ssl: see above
interface: see above
pings: see above
require_zero_status: see above
ssl2: see above
timeout: see above
urlformat: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
agent: see above
This variable inherits its value from the parent section if nothing is specified here.
expect: see above
This variable inherits its value from the parent section if nothing is specified here.
extraargs: see above
This variable inherits its value from the parent section if nothing is specified here.
extrare: see above
This variable inherits its value from the parent section if nothing is specified here.
follow_redirects: see above
This variable inherits its value from the parent section if nothing is specified here.
include_redirects: see above
This variable inherits its value from the parent section if nothing is specified here.
insecure_ssl: see above
This variable inherits its value from the parent section if nothing is specified here.
interface: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
require_zero_status: see above
This variable inherits its value from the parent section if nothing is specified here.
ssl2: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
urlformat: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "Curl".)

DNS: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
lookup: see above
pings: see above
server: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
lookup: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
server: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "DNS".)

DismanPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
ownerindex: see above
packetsize: see above
pinghost: see above
pingsrc: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
ownerindex: see above
This variable inherits its value from the parent section if nothing is specified here.
packetsize: see above
This variable inherits its value from the parent section if nothing is specified here.
pinghost: see above
This variable inherits its value from the parent section if nothing is specified here.
pingsrc: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "DismanPing".)

EchoPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
extraopts: see above
fill: see above
ipversion: see above
pings: see above
priority: see above
size: see above
timeout: see above
tos: see above
udp: see above
waittime: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
extraopts: see above
This variable inherits its value from the parent section if nothing is specified here.
fill: see above
This variable inherits its value from the parent section if nothing is specified here.
ipversion: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
priority: see above
This variable inherits its value from the parent section if nothing is specified here.
size: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
tos: see above
This variable inherits its value from the parent section if nothing is specified here.
udp: see above
This variable inherits its value from the parent section if nothing is specified here.
waittime: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPing".)

EchoPingChargen: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
extraopts: see above
fill: see above
ipversion: see above
pings: see above
priority: see above
size: see above
timeout: see above
tos: see above
waittime: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
extraopts: see above
This variable inherits its value from the parent section if nothing is specified here.
fill: see above
This variable inherits its value from the parent section if nothing is specified here.
ipversion: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
priority: see above
This variable inherits its value from the parent section if nothing is specified here.
size: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
tos: see above
This variable inherits its value from the parent section if nothing is specified here.
waittime: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPingChargen".)

EchoPingDNS: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
dns_request: see above
dns_tcp: see above
dns_type: see above
extraopts: see above
ipversion: see above
pings: see above
plugin: see above
pluginargs: see above
priority: see above
timeout: see above
tos: see above
waittime: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
dns_request: see above
This variable inherits its value from the parent section if nothing is specified here.
dns_tcp: see above
This variable inherits its value from the parent section if nothing is specified here.
dns_type: see above
This variable inherits its value from the parent section if nothing is specified here.
extraopts: see above
This variable inherits its value from the parent section if nothing is specified here.
ipversion: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
plugin: see above
This variable inherits its value from the parent section if nothing is specified here.
pluginargs: see above
This variable inherits its value from the parent section if nothing is specified here.
priority: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
tos: see above
This variable inherits its value from the parent section if nothing is specified here.
waittime: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPingDNS".)

EchoPingDiscard: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
extraopts: see above
fill: see above
ipversion: see above
pings: see above
priority: see above
size: see above
timeout: see above
tos: see above
udp: see above
waittime: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
extraopts: see above
This variable inherits its value from the parent section if nothing is specified here.
fill: see above
This variable inherits its value from the parent section if nothing is specified here.
ipversion: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
priority: see above
This variable inherits its value from the parent section if nothing is specified here.
size: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
tos: see above
This variable inherits its value from the parent section if nothing is specified here.
udp: see above
This variable inherits its value from the parent section if nothing is specified here.
waittime: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPingDiscard".)

EchoPingHttp: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
accept_redirects: see above
extraopts: see above
ignore_cache: see above
ipversion: see above
pings: see above
port: see above
priority: see above
revalidate_data: see above
timeout: see above
tos: see above
url: see above
waittime: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
accept_redirects: see above
This variable inherits its value from the parent section if nothing is specified here.
extraopts: see above
This variable inherits its value from the parent section if nothing is specified here.
ignore_cache: see above
This variable inherits its value from the parent section if nothing is specified here.
ipversion: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
port: see above
This variable inherits its value from the parent section if nothing is specified here.
priority: see above
This variable inherits its value from the parent section if nothing is specified here.
revalidate_data: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
tos: see above
This variable inherits its value from the parent section if nothing is specified here.
url: see above
This variable inherits its value from the parent section if nothing is specified here.
waittime: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPingHttp".)

EchoPingHttps: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
accept_redirects: see above
extraopts: see above
ignore_cache: see above
ipversion: see above
pings: see above
port: see above
priority: see above
prot: see above
revalidate_data: see above
timeout: see above
tos: see above
url: see above
waittime: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
accept_redirects: see above
This variable inherits its value from the parent section if nothing is specified here.
extraopts: see above
This variable inherits its value from the parent section if nothing is specified here.
ignore_cache: see above
This variable inherits its value from the parent section if nothing is specified here.
ipversion: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
port: see above
This variable inherits its value from the parent section if nothing is specified here.
priority: see above
This variable inherits its value from the parent section if nothing is specified here.
prot: see above
This variable inherits its value from the parent section if nothing is specified here.
revalidate_data: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
tos: see above
This variable inherits its value from the parent section if nothing is specified here.
url: see above
This variable inherits its value from the parent section if nothing is specified here.
waittime: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPingHttps".)

EchoPingIcp: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
extraopts: see above
ipversion: see above
pings: see above
priority: see above
timeout: see above
tos: see above
url: see above
waittime: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
extraopts: see above
This variable inherits its value from the parent section if nothing is specified here.
ipversion: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
priority: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
tos: see above
This variable inherits its value from the parent section if nothing is specified here.
url: see above
This variable inherits its value from the parent section if nothing is specified here.
waittime: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPingIcp".)

EchoPingLDAP: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
extraopts: see above
ipversion: see above
ldap_base: see above
ldap_request: see above
ldap_scope: see above
pings: see above
plugin: see above
pluginargs: see above
priority: see above
timeout: see above
tos: see above
waittime: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
extraopts: see above
This variable inherits its value from the parent section if nothing is specified here.
ipversion: see above
This variable inherits its value from the parent section if nothing is specified here.
ldap_base: see above
This variable inherits its value from the parent section if nothing is specified here.
ldap_request: see above
This variable inherits its value from the parent section if nothing is specified here.
ldap_scope: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
plugin: see above
This variable inherits its value from the parent section if nothing is specified here.
pluginargs: see above
This variable inherits its value from the parent section if nothing is specified here.
priority: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
tos: see above
This variable inherits its value from the parent section if nothing is specified here.
waittime: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPingLDAP".)

EchoPingPlugin: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
extraopts: see above
ipversion: see above
pings: see above
plugin: see above
pluginargs: see above
priority: see above
timeout: see above
tos: see above
waittime: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
extraopts: see above
This variable inherits its value from the parent section if nothing is specified here.
ipversion: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
plugin: see above
This variable inherits its value from the parent section if nothing is specified here.
pluginargs: see above
This variable inherits its value from the parent section if nothing is specified here.
priority: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
tos: see above
This variable inherits its value from the parent section if nothing is specified here.
waittime: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPingPlugin".)

EchoPingSmtp: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
extraopts: see above
ipversion: see above
pings: see above
priority: see above
timeout: see above
tos: see above
waittime: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
extraopts: see above
This variable inherits its value from the parent section if nothing is specified here.
ipversion: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
priority: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
tos: see above
This variable inherits its value from the parent section if nothing is specified here.
waittime: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPingSmtp".)

EchoPingWhois: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
extraopts: see above
ipversion: see above
pings: see above
plugin: see above
pluginargs: see above
priority: see above
timeout: see above
tos: see above
waittime: see above
whois_request: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
extraopts: see above
This variable inherits its value from the parent section if nothing is specified here.
ipversion: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
plugin: see above
This variable inherits its value from the parent section if nothing is specified here.
pluginargs: see above
This variable inherits its value from the parent section if nothing is specified here.
priority: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
tos: see above
This variable inherits its value from the parent section if nothing is specified here.
waittime: see above
This variable inherits its value from the parent section if nothing is specified here.
whois_request: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "EchoPingWhois".)

FPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "FPing".)

FPing6: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "FPing6".)

FPingContinuous: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "FPingContinuous".)

FTPtransfer: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
localaddr: see above
passive: see above
password: see above
pings: see above
port: see above
timeout: see above
username: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
localaddr: see above
This variable inherits its value from the parent section if nothing is specified here.
passive: see above
This variable inherits its value from the parent section if nothing is specified here.
password: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
port: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
username: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "FTPtransfer".)

IOSPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
ioshost: see above
iosint: see above
iosuser: see above
pings: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
ioshost: see above
This variable inherits its value from the parent section if nothing is specified here.
iosint: see above
This variable inherits its value from the parent section if nothing is specified here.
iosuser: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "IOSPing".)

IRTT: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
dscp: see above
extraargs: see above
fill: see above
hmac: see above
interval: see above
ipversion: see above
length: see above
localaddr: see above
metric: see above
pings: see above
readfrom: see above
readfrompollinterval: see above
serverfill: see above
sleep: see above
writeto: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
dscp: see above
This variable inherits its value from the parent section if nothing is specified here.
extraargs: see above
This variable inherits its value from the parent section if nothing is specified here.
fill: see above
This variable inherits its value from the parent section if nothing is specified here.
hmac: see above
This variable inherits its value from the parent section if nothing is specified here.
interval: see above
This variable inherits its value from the parent section if nothing is specified here.
ipversion: see above
This variable inherits its value from the parent section if nothing is specified here.
length: see above
This variable inherits its value from the parent section if nothing is specified here.
localaddr: see above
This variable inherits its value from the parent section if nothing is specified here.
metric: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
readfrom: see above
This variable inherits its value from the parent section if nothing is specified here.
readfrompollinterval: see above
This variable inherits its value from the parent section if nothing is specified here.
serverfill: see above
This variable inherits its value from the parent section if nothing is specified here.
sleep: see above
This variable inherits its value from the parent section if nothing is specified here.
writeto: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "IRTT".)

LDAP: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
attrs: see above
base: see above
binddn: see above
filter: see above
mininterval: see above
password: see above
pings: see above
port: see above
scheme: see above
scope: see above
start_tls: see above
timeout: see above
verify: see above
version: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
attrs: see above
This variable inherits its value from the parent section if nothing is specified here.
base: see above
This variable inherits its value from the parent section if nothing is specified here.
binddn: see above
This variable inherits its value from the parent section if nothing is specified here.
filter: see above
This variable inherits its value from the parent section if nothing is specified here.
mininterval: see above
This variable inherits its value from the parent section if nothing is specified here.
password: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
port: see above
This variable inherits its value from the parent section if nothing is specified here.
scheme: see above
This variable inherits its value from the parent section if nothing is specified here.
scope: see above
This variable inherits its value from the parent section if nothing is specified here.
start_tls: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
verify: see above
This variable inherits its value from the parent section if nothing is specified here.
version: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "LDAP".)

NFSping: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "NFSping".)

OpenSSHEOSPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
eospass: see above
eosuser: see above
pings: see above
psource: see above
source: see above
unpriv: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
eospass: see above
This variable inherits its value from the parent section if nothing is specified here.
eosuser: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
psource: see above
This variable inherits its value from the parent section if nothing is specified here.
source: see above
This variable inherits its value from the parent section if nothing is specified here.
unpriv: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "OpenSSHEOSPing".)

OpenSSHJunOSPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
junospass: see above
junosuser: see above
pings: see above
psource: see above
source: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
junospass: see above
This variable inherits its value from the parent section if nothing is specified here.
junosuser: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
psource: see above
This variable inherits its value from the parent section if nothing is specified here.
source: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "OpenSSHJunOSPing".)

Qstat: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
pings: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "Qstat".)

Radius: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
allowreject: see above
mininterval: see above
nas_ip_address: see above
password: see above
pings: see above
port: see above
secret: see above
timeout: see above
username: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
allowreject: see above
This variable inherits its value from the parent section if nothing is specified here.
mininterval: see above
This variable inherits its value from the parent section if nothing is specified here.
nas_ip_address: see above
This variable inherits its value from the parent section if nothing is specified here.
password: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
port: see above
This variable inherits its value from the parent section if nothing is specified here.
secret: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
username: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "Radius".)

RemoteFPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "RemoteFPing".)

SSH: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
keytype: see above
pings: see above
port: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
keytype: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
port: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "SSH".)

SendEmail: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
pings: see above
port: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
port: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "SendEmail".)

SipSak: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
keep_second: see above
params: see above
pings: see above
port: see above
sipsak_timeout: see above
user: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
keep_second: see above
This variable inherits its value from the parent section if nothing is specified here.
params: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
port: see above
This variable inherits its value from the parent section if nothing is specified here.
sipsak_timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
user: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "SipSak".)

TCPPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
pings: see above
port: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
port: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "TCPPing".)

TacacsPlus: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
authtype: see above
mininterval: see above
password: see above
pings: see above
port: see above
secret: see above
timeout: see above
username: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
authtype: see above
This variable inherits its value from the parent section if nothing is specified here.
mininterval: see above
This variable inherits its value from the parent section if nothing is specified here.
password: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
port: see above
This variable inherits its value from the parent section if nothing is specified here.
secret: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.
username: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "TacacsPlus".)

TelnetIOSPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
iospass: see above
iosuser: see above
pings: see above
psource: see above
source: see above
vrf: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
iospass: see above
This variable inherits its value from the parent section if nothing is specified here.
iosuser: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
psource: see above
This variable inherits its value from the parent section if nothing is specified here.
source: see above
This variable inherits its value from the parent section if nothing is specified here.
vrf: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "TelnetIOSPing".)

TelnetJunOSPing: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
junospass: see above
junosuser: see above
pings: see above
psource: see above
source: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
junospass: see above
This variable inherits its value from the parent section if nothing is specified here.
junosuser: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
psource: see above
This variable inherits its value from the parent section if nothing is specified here.
source: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "TelnetJunOSPing".)

TraceroutePing: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
desthost: see above
host: see above
maxttl: see above
minttl: see above
pings: see above
wait: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
desthost: see above
This variable inherits its value from the parent section if nothing is specified here.
maxttl: see above
This variable inherits its value from the parent section if nothing is specified here.
minttl: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
wait: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "TraceroutePing".)

WebProxyFilter: (See the separate module documentation for details about each variable.): The following new variables are valid:

/^influx_.+/: see above
deny_re: see above
more_hosts: see above
pings: see above
timeout: see above

Syntax changes for subsection /[-_0-9a-zA-Z]+/

The following new variables are valid:

/^influx_.+/: see above
This variable inherits its value from the parent section if nothing is specified here.
deny_re: see above
This variable inherits its value from the parent section if nothing is specified here.
more_hosts: see above
This variable inherits its value from the parent section if nothing is specified here.
pings: see above
This variable inherits its value from the parent section if nothing is specified here.
timeout: see above
This variable inherits its value from the parent section if nothing is specified here.

(End of dynamical grammar changes for variable "probe" example value "WebProxyFilter".)

(End of dynamical grammar changes for example values of variable "probe".)

* Alerts *

The Alert section lets you setup loss and RTT pattern detectors. After each round of polling, SmokePing will examine its data and determine which detectors match. Detectors are enabled per target and get inherited by the targets children.

Detectors are not just simple thresholds which go off at first sight of a problem. They are configurable to detect special loss or RTT patterns. They let you look at a number of past readings to make a more educated decision on what kind of alert should be sent, or if an alert should be sent at all.

The patterns are numbers prefixed with an operator indicating the type of comparison required for a match.

The following RTT pattern detects if a target's RTT goes from constantly below 10ms to constantly 100ms and more:

 old ------------------------------> new
 <10,<10,<10,<10,<10,>10,>100,>100,>100

Loss patterns work in a similar way, except that the loss is defined as the percentage the total number of received packets is of the total number of packets sent.

 old ------------------------------> new
 ==0%,==0%,==0%,==0%,>20%,>20%,>=20%

Apart from normal numbers, patterns can also contain the values * which is true for all values regardless of the operator. And U which is true for unknown data together with the == and =! operators.

Detectors normally act on state changes. This has the disadvantage, that they will fail to find conditions which were already present when launching smokeping. For this it is possible to write detectors that begin with the special value ==S it is inserted whenever smokeping is started up.

You can write

 ==S,>20%,>20%

to detect lines that have been losing more than 20% of the packets for two periods after startup.

If you want to make sure a value within a certain range you can use two conditions in one element

 >45%<=55%

Sometimes it may be that conditions occur at irregular intervals. But still you only want to throw an alert if they occur several times within a certain time period. The operator *X* will ignore up to X values and still let the pattern match:

  >10%,*10*,>10%

will fire if more than 10% of the packets have been lost at least twice over the last 10 samples.

A complete example

 *** Alerts ***
 to = admin@company.xy,peter@home.xy
 from = smokealert@company.xy

 +lossdetect
 type = loss
 # in percent
 pattern = ==0%,==0%,==0%,==0%,>20%,>20%,>20%
 comment = suddenly there is packet loss

 +miniloss
 type = loss
 # in percent
 pattern = >0%,*12*,>0%,*12*,>0%
 comment = detected loss 3 times over the last two hours

 +rttdetect
 type = rtt
 # in milliseconds
 pattern = <10,<10,<10,<10,<10,<100,>100,>100,>100
 comment = routing messed up again ?

 +rttbadstart
 type = rtt
 # in milliseconds
 pattern = ==S,==U
 comment = offline at startup

The following variables can be set in this section:

to (mandatory setting)

Either an email address to send alerts to, or the name of a program to execute when an alert matches. To call a program, the first character of the to value must be a pipe symbol "|". The program will the be called whenever an alert matches, using the following 5 arguments (except if edgetrigger is 'yes'; see below): name-of-alert, target, loss-pattern, rtt-pattern, hostname. You can also provide a comma separated list of addresses and programs.

from (mandatory setting)

who should alerts appear to be coming from ?

edgetrigger

The alert notifications and/or the programs executed are normally triggered every time the alert matches. If this variable is set to 'yes', they will be triggered only when the alert's state is changed, ie. when it's raised and when it's cleared. Subsequent matches of the same alert will thus not trigger a notification.

When this variable is set to 'yes', a notification program (see the to variable documentation above) will get a sixth argument, raise, which has the value 1 if the alert was just raised and 0 if it was cleared.

Default value: edgetrigger = no

mailtemplate

When sending out mails for alerts, smokeping normally uses an internally generated message. With the mailtemplate you can specify a filename for a custom template. The file should contain a 'Subject: ...' line. The rest of the file should contain text. The all <##keyword##> type strings will get replaced in the template before it is sent out. the following keywords are supported:

 <##ALERT##>    - target name
 <##WHAT##>     - status (is active, was raised, was cleared)
 <##LINE##>     - path in the config tree
 <##URL##>      - webpage for graph
 <##STAMP##>    - date and time 
 <##PAT##>      - pattern that matched the alert
 <##LOSS##>     - loss history
 <##RTT##>      - rtt history
 <##COMMENT##>  - comment

The following sections are valid on level 1:

+/[^\s,]+/: The following variables can be set in this section:

type (mandatory setting)

Currently the pattern types rtt and loss and matcher are known.

Matchers are plugin modules that extend the alert conditions. Known matchers are Avgratio, CheckLatency, CheckLoss, ConsecutiveLoss, ExpLoss, Median, Medratio.

See the documentation of the corresponding matcher module (eg. Smokeping::matchers::Avgratio) for instructions on configuring it.

pattern (mandatory setting)

a comma separated list of comparison operators and numbers. rtt patterns are in milliseconds, loss patterns are in percents

comment (mandatory setting)

to

Similar to the "to" parameter on the top-level except that it will only be used IN ADDITION to the value of the toplevel parameter. Same rules apply.

edgetrigger

This variable inherits its value from the parent section if nothing is specified here.

Default value: edgetrigger = no

mailtemplate

This variable inherits its value from the parent section if nothing is specified here.

priority

if multiple alerts 'match' only the one with the highest priority (lowest number) will cause and alert to be sent. Alerts without priority will be sent in any case.

* Slaves *

Your smokeping can remote control other somkeping instances running in slave mode on different hosts. Use this section to tell your master smokeping about the slaves you are going to use.

The following variables can be set in this section:

secrets (mandatory setting)

The slave secrets file contains one line per slave with the name of the slave followed by a colon and the secret:

 slave1:secret1
 slave2:secret2
 ...

Note that these secrets combined with a man-in-the-middle attack effectively give shell access to the corresponding slaves (see smokeping_master_slave), so the file should be appropriately protected and the secrets should not be easily crackable.

The following sections are valid on level 1:

+/[-_0-9a-zA-Z.]+/: Define some basic properties for the slave.
The following variables can be set in this section:

display_name (mandatory setting): Name of the Slave host.
location: Where is the slave located.
color (mandatory setting): Color for the slave in graphs where input from multiple hosts is presented.

The following sections are valid on level 2:

++override

If part of the configuration information must be overwritten to match the settings of the you can specify this in this section. A setting is overwritten by giving the full path of the configuration variable. If you have this configuration in the Probes section:

 *** Probes ***
 +FPing
 binary = /usr/sepp/bin/fping

You can override it for a particular slave like this:

 ++override
 Probes.FPing.binary = /usr/bin/fping

The following variables can be set in this section:

/\S+/

* InfluxDB *

If you want to export data to an InfluxDB database, fill in this section.

The following variables can be set in this section:

host (mandatory setting): The FQDN or IP address of your InfluxDB server. For example 'localhost', 'influx.example.org' or '127.0.0.1'
port: The port of your InfluxDB server. Default is 8086
Default value: port = 8086
timeout: Connection timeout to InfluxDB in seconds. Default is 15s. Too big of a timeout will cause polling errors when InfluxDB is down.
Default value: timeout = 15
database (mandatory setting): Database name (where to write the data) within InfluxDB. If it doesn't exist, it will be created when writing data.
username: Username for authentication to InfluxDB. If not supplied, no authentication is attempted.
password: Password for authentication to InfluxDB. If not supplied, no authentication is attempted.

COPYRIGHT

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

AUTHOR

Tobias Oetiker <tobi@oetiker.ch>