Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Smokeping_probes_SendEmail(3)	   SmokePing	 Smokeping_probes_SendEmail(3)

NAME
       Smokeping::probes::SendEmail - a	Smokeping probe	that measure time
       neeed to	send an	mail

SYNOPSIS
	*** Probes ***

	+SendEmail

	bodysize = 0
	forks =	5
	from = test@test.com # mandatory
	offset = 50%
	step = 300
	subject	= Test
	timeout	= 15
	to =  #	mandatory

	# The following	variables can be overridden in each target section
	pings =	5
	port = 25

	# [...]

	*** Targets ***

	probe =	SendEmail # if this should be the default probe

	# [...]

	+ mytarget
	# probe	= SendEmail # if the default probe is something	else
	host = my.host
	pings =	5
	port = 25

DESCRIPTION
       This probe actually send	a mail to a MX server and measure time it
       took. You can choose the	sender and recipient adress as well as the
       size of the mail.

VARIABLES
       Supported probe-specific	variables:

       bodysize
	   Size	of the mail to send in bytes. If set to	0, a default mail
	   content will	be set.	Note that mail always contain From, To and
	   Subject headers.

	   Default value: 0

       forks
	   Run this many concurrent processes at maximum

	   Example value: 5

	   Default value: 5

       from
	   Mail	from address

	   Example value: test@test.com

	   This	setting	is mandatory.

       offset
	   If you run many probes concurrently you may want to prevent them
	   from	hitting	your network all at the	same time. Using the probe-
	   specific offset parameter you can change the	point in time when
	   each	probe will be run. Offset is specified in % of total interval,
	   or alternatively as 'random', and the offset	from the 'General'
	   section is used if nothing is specified here. Note that this	does
	   NOT influence the rrds itself, it is	just a matter of when data
	   acqusition is initiated.  (This variable is only applicable if the
	   variable 'concurrentprobes' is set in the 'General' section.)

	   Example value: 50%

       step
	   Duration of the base	interval that this probe should	use, if
	   different from the one specified in the 'Database' section. 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. (This
	   variable is only applicable if the variable 'concurrentprobes' is
	   set in the 'General'	section.)

	   Example value: 300

       subject
	   Subject of the mail

	   Default value: Test

       timeout
	   How long a single 'ping' takes at maximum

	   Example value: 15

	   Default value: 5

       to  Rcpt	to address

	   This	setting	is mandatory.

       Supported target-specific variables:

       pings
	   How many pings should be sent to each target, if different from the
	   global value	specified in the Database section. 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.

	   Example value: 5

       port
	   Port	of the SMTP server to reach

	   Default value: 25

AUTHORS
	Florian	Coulmier <florian@coulmier.fr>,

SEE ALSO
       smokeping_extend

2.7.3				  2020-08-30	 Smokeping_probes_SendEmail(3)

NAME | SYNOPSIS | DESCRIPTION | VARIABLES | AUTHORS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Smokeping_probes_SendEmail&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help