1Smokeping_probes_TelnetIOSPing(3)  SmokePing Smokeping_probes_TelnetIOSPing(3)
2
3
4

NAME

6       Smokeping::probes::TelnetIOSPing - Cisco IOS Probe for SmokePing
7

SYNOPSIS

9        *** Probes ***
10
11        +TelnetIOSPing
12
13        forks = 5
14        offset = 50%
15        packetsize = 56
16        step = 300
17        timeout = 15
18
19        # The following variables can be overridden in each target section
20        iospass = password # mandatory
21        iosuser = user # mandatory
22        pings = 5
23        psource = 192.168.2.129
24        source = 192.168.2.1 # mandatory
25        vrf = VRF1
26
27        # [...]
28
29        *** Targets ***
30
31        probe = TelnetIOSPing # if this should be the default probe
32
33        # [...]
34
35        + mytarget
36        # probe = TelnetIOSPing # if the default probe is something else
37        host = my.host
38        iospass = password # mandatory
39        iosuser = user # mandatory
40        pings = 5
41        psource = 192.168.2.129
42        source = 192.168.2.1 # mandatory
43        vrf = VRF1
44

DESCRIPTION

46       Integrates Cisco IOS as a probe into smokeping.  Uses the telnet
47       protocol to run a ping from an IOS device (source) to another device
48       (host).  This probe basically uses the "extended ping" of the Cisco
49       IOS.  You have the option to specify which interface the ping is
50       sourced from as well.
51

VARIABLES

53       Supported probe-specific variables:
54
55       forks
56           Run this many concurrent processes at maximum
57
58           Example value: 5
59
60           Default value: 5
61
62       offset
63           If you run many probes concurrently you may want to prevent them
64           from hitting your network all at the same time. Using the probe-
65           specific offset parameter you can change the point in time when
66           each probe will be run. Offset is specified in % of total interval,
67           or alternatively as 'random', and the offset from the 'General'
68           section is used if nothing is specified here. Note that this does
69           NOT influence the rrds itself, it is just a matter of when data
70           acqusition is initiated.  (This variable is only applicable if the
71           variable 'concurrentprobes' is set in the 'General' section.)
72
73           Example value: 50%
74
75       packetsize
76           The (optional) packetsize option lets you configure the packetsize
77           for the pings sent.
78
79           Default value: 56
80
81       step
82           Duration of the base interval that this probe should use, if
83           different from the one specified in the 'Database' section. Note
84           that the step in the RRD files is fixed when they are originally
85           generated, and if you change the step parameter afterwards, you'll
86           have to delete the old RRD files or somehow convert them. (This
87           variable is only applicable if the variable 'concurrentprobes' is
88           set in the 'General' section.)
89
90           Example value: 300
91
92       timeout
93           How long a single 'ping' takes at maximum
94
95           Example value: 15
96
97           Default value: 5
98
99       Supported target-specific variables:
100
101       iospass
102           The iospass option allows you to specify the password for the
103           username specified with the option iosuser.
104
105           Example value: password
106
107           This setting is mandatory.
108
109       iosuser
110           The iosuser option allows you to specify a username that has ping
111           capability on the IOS Device.
112
113           Example value: user
114
115           This setting is mandatory.
116
117       pings
118           How many pings should be sent to each target, if different from the
119           global value specified in the Database section. Note that the
120           number of pings in the RRD files is fixed when they are originally
121           generated, and if you change this parameter afterwards, you'll have
122           to delete the old RRD files or somehow convert them.
123
124           Example value: 5
125
126       psource
127           The (optional) psource option specifies an alternate IP address or
128           Interface from which you wish to source your pings from.  Routers
129           can have many many IP addresses, and interfaces.  When you ping
130           from a router you have the ability to choose which interface and/or
131           which IP address the ping is sourced from.  Specifying an
132           IP/interface does not necessarily specify the interface from which
133           the ping will leave, but will specify which address the packet(s)
134           appear to come from.  If this option is left out the IOS Device
135           will source the packet automatically based on routing and/or
136           metrics.  If this doesn't make sense to you then just leave it out.
137
138           Example value: 192.168.2.129
139
140       source
141           The source option specifies the IOS device to which we telnet.
142           This is an IP address of an IOS Device that you/your server:
143                1)  Have the ability to telnet to      2)  Have a valid
144           username and password for
145
146           Example value: 192.168.2.1
147
148           This setting is mandatory.
149
150       vrf The vrf option allows you to specify the vrf for ping
151
152           Example value: VRF1
153

AUTHORS

155       John A Jackson <geonjay@infoave.net>
156
157       based HEAVILY on Smokeping::probes::IOSPing by
158
159       Paul J Murphy <paul@murph.org>
160
161       based on Smokeping::probes::FPing by
162
163       Tobias Oetiker <tobi@oetiker.ch>
164

NOTES

166   IOS configuration
167       The IOS device should have a username/password configured, as well as
168       the ability to connect to the VTY(s).  eg:
169
170           !
171           username smokeping privilege 5 password 0 SmokepingPassword
172           !
173           line vty 0 4
174            login local
175            transport input telnet
176           !
177
178       Some IOS devices have a maximum of 5 VTYs available, so be careful not
179       to hit a limit with the 'forks' variable.
180
181   Requirements
182       This module requires the Net::Telnet module for perl.  This is usually
183       included on most newer OSs which include perl.
184
185   Debugging
186       There is some VERY rudimentary debugging code built into this module
187       (it's based on the debugging code written into Net::Telnet).  It will
188       log information into three files "TIPreturn", "TIPoutlog", and
189       "TIPdump".  These files will be written out into your current working
190       directory (CWD).  You can change the names of these files to something
191       with more meaning to you.
192
193   Password authentication
194       You should be advised that the authentication method of telnet uses
195       clear text transmissions...meaning that without proper network security
196       measures someone could sniff your username and password off the
197       network.  I may attempt to incorporate SSH in a future version of this
198       module, but it is very doubtful.  Right now SSH adds a LOT of
199       processing overhead to a router, and isn't incredibly easy to implement
200       in perl.
201
202       Having said this, don't be too scared of telnet.  Remember, the
203       original IOSPing module used RSH, which is even more scary to use from
204       a security perspective.
205
206   Ping packet size
207       The FPing manpage has the following to say on the topic of ping packet
208       size:
209
210       Number of bytes of ping data to send.  The minimum size (normally 12)
211       allows room for the data that fping needs to do its work (sequence
212       number, timestamp).  The reported received data size includes the IP
213       header (normally 20 bytes) and ICMP header (8 bytes), so the minimum
214       total size is 40 bytes.  Default is 56, as in ping. Maximum is the
215       theoretical maximum IP datagram size (64K), though most systems limit
216       this to a smaller, system-dependent number.
217
218
219
2202.7.3                             2021-03-11 Smokeping_probes_TelnetIOSPing(3)
Impressum