1
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
4
.\" ========================================================================
5
.de Sh \" Subsection heading
13
.de Sp \" Vertical space (when we can't use .PP)
17
.de Vb \" Begin verbatim text
22
.de Ve \" End verbatim text
26
.\" Set up some character translations and predefined strings. \*(-- will
27
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28
.\" double quote, and \*(R" will give a right double quote. | will give a
29
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31
.\" expand to `' in nroff, nothing in troff, for use with C<>.
33
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51
.\" If the F register is turned on, we'll generate index entries on stderr for
52
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53
.\" entries marked with X<> in POD. Of course, you'll have to process the
54
.\" output yourself in some meaningful fashion.
57
. tm Index:\\$1\t\\n%\t"\\$2"
63
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64
.\" way too many mistakes in technical documents.
68
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69
.\" Fear. Run. Save yourself. No user-serviceable parts.
70
. \" fudge factors for nroff and troff
79
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85
. \" simple accents for nroff and troff
95
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102
. \" troff and (daisy-wheel) nroff accents
103
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110
.ds ae a\h'-(\w'a'u*4/10)'e
111
.ds Ae A\h'-(\w'A'u*4/10)'E
112
. \" corrections for vroff
113
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115
. \" for low resolution devices (crt and lpr)
116
.if \n(.H>23 .if \n(.V>19 \
129
.\" ========================================================================
131
.IX Title "doc::Smokeping::probes::TelnetIOSPing 3"
132
.TH doc::Smokeping::probes::TelnetIOSPing 3 "2006-07-14" "2.0.9" "SmokePing"
134
Smokeping::probes::TelnetIOSPing \- Cisco IOS Probe for SmokePing
136
.IX Header "SYNOPSIS"
154
\& # The following variables can be overridden in each target section
155
\& iospass = password # mandatory
156
\& iosuser = user # mandatory
158
\& psource = 192.168.2.129
159
\& source = 192.168.2.1 # mandatory
171
\& probe = TelnetIOSPing # if this should be the default probe
180
\& # probe = TelnetIOSPing # if the default probe is something else
182
\& iospass = password # mandatory
183
\& iosuser = user # mandatory
185
\& psource = 192.168.2.129
186
\& source = 192.168.2.1 # mandatory
189
.IX Header "DESCRIPTION"
190
Integrates Cisco \s-1IOS\s0 as a probe into smokeping. Uses the telnet protocol
191
to run a ping from an \s-1IOS\s0 device (source) to another device (host).
192
This probe basically uses the \*(L"extended ping\*(R" of the Cisco \s-1IOS\s0. You have
193
the option to specify which interface the ping is sourced from as well.
195
.IX Header "VARIABLES"
196
Supported probe-specific variables:
199
Run this many concurrent processes at maximum
206
If you run many probes concurrently you may want to prevent them from
207
hitting your network all at the same time. Using the probe-specific
208
offset parameter you can change the point in time when each probe will
209
be run. Offset is specified in % of total interval, or alternatively as
210
\&'random', and the offset from the 'General' section is used if nothing
211
is specified here. Note that this does \s-1NOT\s0 influence the rrds itself,
212
it is just a matter of when data acqusition is initiated.
213
(This variable is only applicable if the variable 'concurrentprobes' is set
214
in the 'General' section.)
218
.IX Item "packetsize"
219
The (optional) packetsize option lets you configure the packetsize for
225
Duration of the base interval that this probe should use, if different
226
from the one specified in the 'Database' section. Note that the step in
227
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
228
change the step parameter afterwards, you'll have to delete the old \s-1RRD\s0
229
files or somehow convert them. (This variable is only applicable if
230
the variable 'concurrentprobes' is set in the 'General' section.)
235
How long a single 'ping' takes at maximum
241
Supported target-specific variables:
244
The iospass option allows you to specify the password for the username
245
specified with the option iosuser.
247
Example value: password
249
This setting is mandatory.
252
The iosuser option allows you to specify a username that has ping
253
capability on the \s-1IOS\s0 Device.
257
This setting is mandatory.
260
How many pings should be sent to each target, if different from the global
261
value specified in the Database section. Note that the number of pings in
262
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
263
change this parameter afterwards, you'll have to delete the old \s-1RRD\s0
264
files or somehow convert them.
269
The (optional) psource option specifies an alternate \s-1IP\s0 address or
270
Interface from which you wish to source your pings from. Routers
271
can have many many \s-1IP\s0 addresses, and interfaces. When you ping from a
272
router you have the ability to choose which interface and/or which \s-1IP\s0
273
address the ping is sourced from. Specifying an IP/interface does not
274
necessarily specify the interface from which the ping will leave, but
275
will specify which address the packet(s) appear to come from. If this
276
option is left out the \s-1IOS\s0 Device will source the packet automatically
277
based on routing and/or metrics. If this doesn't make sense to you
278
then just leave it out.
280
Example value: 192.168.2.129
283
The source option specifies the \s-1IOS\s0 device to which we telnet. This
284
is an \s-1IP\s0 address of an \s-1IOS\s0 Device that you/your server:
285
1) Have the ability to telnet to
286
2) Have a valid username and password for
288
Example value: 192.168.2.1
290
This setting is mandatory.
293
John A Jackson <geonjay@infoave.net>
295
based \s-1HEAVILY\s0 on Smokeping::probes::IOSPing by
297
Paul J Murphy <paul@murph.org>
299
based on Smokeping::probes::FPing by
301
Tobias Oetiker <tobi@oetiker.ch>
304
.Sh "\s-1IOS\s0 configuration"
305
.IX Subsection "IOS configuration"
306
The \s-1IOS\s0 device should have a username/password configured, as well as
307
the ability to connect to the \s-1VTY\s0(s).
312
\& username smokeping privilege 5 password 0 SmokepingPassword
316
\& transport input telnet
320
Some \s-1IOS\s0 devices have a maximum of 5 VTYs available, so be careful not
321
to hit a limit with the 'forks' variable.
323
.IX Subsection "Requirements"
324
This module requires the Net::Telnet module for perl. This is usually
325
included on most newer OSs which include perl.
327
.IX Subsection "Debugging"
328
There is some \s-1VERY\s0 rudimentary debugging code built into this module (it's
329
based on the debugging code written into Net::Telnet). It will log
330
information into three files \*(L"TIPreturn\*(R", \*(L"TIPoutlog\*(R", and \*(L"TIPdump\*(R".
331
These files will be written out into your current working directory (\s-1CWD\s0).
332
You can change the names of these files to something with more meaning to
334
.Sh "Password authentication"
335
.IX Subsection "Password authentication"
336
You should be advised that the authentication method of telnet uses
337
clear text transmissions...meaning that without proper network security
338
measures someone could sniff your username and password off the network.
339
I may attempt to incorporate \s-1SSH\s0 in a future version of this module, but
340
it is very doubtful. Right now \s-1SSH\s0 adds a \s-1LOT\s0 of processing overhead to
341
a router, and isn't incredibly easy to implement in perl.
343
Having said this, don't be too scared of telnet. Remember, the
344
original IOSPing module used \s-1RSH\s0, which is even more scary to use from
345
a security perspective.
346
.Sh "Ping packet size"
347
.IX Subsection "Ping packet size"
348
The FPing manpage has the following to say on the topic of ping packet
351
Number of bytes of ping data to send. The minimum size (normally 12)
352
allows room for the data that fping needs to do its work (sequence
353
number, timestamp). The reported received data size includes the \s-1IP\s0
354
header (normally 20 bytes) and \s-1ICMP\s0 header (8 bytes), so the minimum
355
total size is 40 bytes. Default is 56, as in ping. Maximum is the
356
theoretical maximum \s-1IP\s0 datagram size (64K), though most systems limit
357
this to a smaller, system-dependent number.
added
removed
doc/Smokeping/probes/Smokeping::probes::TelnetIOSPing.3
