.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Smokeping_probes_FTPtransfer 3"
.TH Smokeping_probes_FTPtransfer 3 "2018-05-15" "2.6.11" "SmokePing"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Smokeping::probes::FTPtransfer \- intrusive bandwidth probe
.SH "OVERVIEW"
.IX Header "OVERVIEW"
This probe send and retrieve files to or from an ftp server. It will plot
the bandwidth it could use.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& *** Probes ***
\&
\& +FTPtransfer
\&
\& destfile = path/to/destinationfile.xxx
\& forks = 5
\& min_interval = 1
\& mode = get # mandatory
\& offset = 50%
\& passwordfile = /some/place/secret
\& srcfile = src/path/mybig.pdf # mandatory
\& step = 300
\& timeout = 15 # mandatory
\&
\& # The following variables can be overridden in each target section
\& localaddr = myhost\-nat\-if
\& passive = yes
\& password = test\-password
\& pings = 5
\& port = 3255
\& timeout = 10
\& username = test\-user
\&
\& # [...]
\&
\& *** Targets ***
\&
\& probe = FTPtransfer # if this should be the default probe
\&
\& # [...]
\&
\& + mytarget
\& # probe = FTPtransfer # if the default probe is something else
\& host = my.host
\& localaddr = myhost\-nat\-if
\& passive = yes
\& password = test\-password
\& pings = 5
\& port = 3255
\& timeout = 10
\& username = test\-user
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The probe uses the Net::FTP perl client to run performance tests using an
\&\s-1FTP\s0 server as a target. This probe is \fBintrusive\fR as it transfers real
data. By using real data we get a fair shot at figuring out what a link is
capable of when it comes to transfering actual files.
.PP
The password can be specified either (in order of precedence, with
the latter overriding the former) in the probe-specific variable
`password', in an external file or in the target-specific variable
`password'.  The location of this external file is given in the probe-specific
variable `passwordfile'. See \fISmokeping::probes::passwordchecker\fR\|(3pm) for the
format of this file (summary: colon-separated triplets of the form
`<host>:<username>:<password>')
.PP
The probe tries to be nice to the server and waits at least X seconds
between starting filetransfers, where X is the value of the probe 
specific `min_interval' variable (1 by default).
.PP
Many variables can be specified either in the probe or in the target definition,
the target-specific variable will override the prove-specific variable.
.PP
If your transfer takes a lot of time, you may want to make sure to set the
\&\fBtimeout\fR and \fBmax_rtt\fR properly so that smokeping does not abort the
transfers of limit the graph size.
.SH "VARIABLES"
.IX Header "VARIABLES"
Supported probe-specific variables:
.IP "destfile" 4
.IX Item "destfile"
Normally the destination filename is the same as the source filename
(without the path). If you want keep files in different directories this may not
work, and you have to specify destfile as well.
.Sp
Example value: path/to/destinationfile.xxx
.IP "forks" 4
.IX Item "forks"
Run this many concurrent processes at maximum
.Sp
Example value: 5
.Sp
Default value: 5
.IP "min_interval" 4
.IX Item "min_interval"
The minimum interval between each starting ftp sessions in seconds.
.Sp
Default value: 1
.IP "mode" 4
.IX Item "mode"
The ftp probe can be in either put or get mode. If it is in put mode then it will send a file to the ftp server. In get mode it will retrieve a file
from the ftp server.
.Sp
Example value: get
.Sp
This setting is mandatory.
.IP "offset" 4
.IX Item "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 \s-1NOT\s0 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.)
.Sp
Example value: 50%
.IP "passwordfile" 4
.IX Item "passwordfile"
Location of the file containing usernames and passwords.
.Sp
Example value: /some/place/secret
.IP "srcfile" 4
.IX Item "srcfile"
The name of the source file. If the probe is in \fBput\fR mode, this file
has to be on the local machine, if the probe is in \fBget\fR mode then this
file should sit in the remote ftp account.
.Sp
Example value: src/path/mybig.pdf
.Sp
This setting is mandatory.
.IP "step" 4
.IX Item "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 \s-1RRD\s0 files is fixed when they are originally generated, and if you
change the step parameter afterwards, you'll have to delete the old \s-1RRD\s0
files or somehow convert them. (This variable is only applicable if
the variable 'concurrentprobes' is set in the 'General' section.)
.Sp
Example value: 300
.IP "timeout" 4
.IX Item "timeout"
The timeout is the maximum amount of time you will allow the probe to
transfer the file. If the probe does not succeed to transfer in the time specified,
it will get killed and a 'loss' will be loged.
.Sp
Since FTPtransfer is an invasive probe you should make sure you do not load
the link for more than a few seconds anyway. Smokeping curently has a hard
limit of 180 seconds for any \s-1RTT.\s0
.Sp
Example value: 15
.Sp
This setting is mandatory.
.PP
Supported target-specific variables:
.IP "localaddr" 4
.IX Item "localaddr"
The local address to be used when making connections
.Sp
Example value: myhost-nat-if
.IP "passive" 4
.IX Item "passive"
Use passive \s-1FTP\s0 protocol
.Sp
Example value: yes
.IP "password" 4
.IX Item "password"
The password for the user, if not present in the password file.
.Sp
Example value: test-password
.IP "pings" 4
.IX Item "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 \s-1RRD\s0 files is fixed when they are originally generated, and if you
change this parameter afterwards, you'll have to delete the old \s-1RRD\s0
files or somehow convert them.
.Sp
Example value: 5
.IP "port" 4
.IX Item "port"
A non-standard \s-1FTP\s0 port to be used
.Sp
Example value: 3255
.IP "timeout" 4
.IX Item "timeout"
Timeout in seconds for the \s-1FTP\s0 transfer to complete.
.Sp
Example value: 10
.IP "username" 4
.IX Item "username"
The username to be tested.
.Sp
Example value: test-user
.SH "AUTHORS"
.IX Header "AUTHORS"
Tobias Oetiker <tobi@oetiker.ch> sponsored by Virtela
.SH "BUGS"
.IX Header "BUGS"
This probe has the capability for saturating your links, so don't use it
unless you know what you are doing.
.PP
The FTPtransfer probe measures bandwidth, but we report the number of
seconds it took to transfer the 'reference' file. This is because curently
the notion of \fIRound Trip Time\fR is at the core of the application. It would
take some re-engineering to split this out in plugins and thus make it
configurable ...