1Smokeping_probes_IOSPing(3) SmokePing Smokeping_probes_IOSPing(3)
2
6 Smokeping::probes::IOSPing - Cisco IOS Probe for SmokePing
7
9 *** Probes ***
10 +IOSPing
12 binary = /usr/bin/rsh # mandatory
14 forks = 5
15 offset = 50%
16 packetsize = 56
17 step = 300
18 timeout = 15
19 # The following variables can be overridden in each target section
21 ioshost = my.cisco.router # mandatory
22 iosint = Ethernet 1/0
23 iosuser = admin
24 pings = 5
25 # [...]
27 *** Targets ***
29 probe = IOSPing # if this should be the default probe
31 # [...]
33 + mytarget
35 # probe = IOSPing # if the default probe is something else
36 host = my.host
37 ioshost = my.cisco.router # mandatory
38 iosint = Ethernet 1/0
39 iosuser = admin
40 pings = 5
41
43 Integrates Cisco IOS as a probe into smokeping. Uses the rsh / remsh
44 protocol to run a ping from an IOS device.
45
47 Supported probe-specific variables:
48 binary
50 The binary option specifies the path of the binary to be used to
51 connect to the IOS device. Commonly used binaries are /usr/bin/rsh
52 and /usr/bin/remsh, although any script or binary should work if
53 can be called as
54 /path/to/binary [ -l user ] router ping
56 to produce the IOS ping dialog on stdin & stdout.
58 Example value: /usr/bin/rsh
60 This setting is mandatory.
62 forks
64 Run this many concurrent processes at maximum
65 Example value: 5
67 Default value: 5
69 offset
71 If you run many probes concurrently you may want to prevent them
72 from hitting your network all at the same time. Using the probe-
73 specific offset parameter you can change the point in time when
74 each probe will be run. Offset is specified in % of total interval,
75 or alternatively as 'random', and the offset from the 'General'
76 section is used if nothing is specified here. Note that this does
77 NOT influence the rrds itself, it is just a matter of when data
78 acqusition is initiated. (This variable is only applicable if the
79 variable 'concurrentprobes' is set in the 'General' section.)
80 Example value: 50%
82 packetsize
84 The (optional) packetsize option lets you configure the packetsize
85 for the pings sent.
86 Default value: 56
88 step
90 Duration of the base interval that this probe should use, if
91 different from the one specified in the 'Database' section. Note
92 that the step in the RRD files is fixed when they are originally
93 generated, and if you change the step parameter afterwards, you'll
94 have to delete the old RRD files or somehow convert them. (This
95 variable is only applicable if the variable 'concurrentprobes' is
96 set in the 'General' section.)
97 Example value: 300
99 timeout
101 How long a single 'ping' takes at maximum
102 Example value: 15
104 Default value: 5
106 Supported target-specific variables:
108 ioshost
110 The ioshost option specifies the IOS device which should be used
111 for the ping.
112 Example value: my.cisco.router
114 This setting is mandatory.
116 iosint
118 The (optional) iosint option allows you to specify the source
119 address or interface in the IOS device. The value should be an IP
120 address or an interface name such as "Ethernet 1/0". If this option
121 is omitted, the IOS device will pick the IP address of the outbound
122 interface to use.
123 Example value: Ethernet 1/0
125 iosuser
127 The (optional) iosuser option allows you to specify the remote
128 username the IOS device. If this option is omitted, the username
129 defaults to the default user used by the remsh command (usually the
130 user running the remsh command, ie the user running SmokePing).
131 Example value: admin
133 pings
135 How many pings should be sent to each target, if different from the
136 global value specified in the Database section. Note that the
137 number of pings in the RRD files is fixed when they are originally
138 generated, and if you change this parameter afterwards, you'll have
139 to delete the old RRD files or somehow convert them.
140 Example value: 5
142
144 Paul J Murphy <paul@murph.org>
145 based on Smokeping::probes::FPing by
147 Tobias Oetiker <tobi@oetiker.ch>
149
151 IOS Configuration
152 The IOS device must have rsh enabled and an appropriate trust defined,
153 eg:
154 !
156 ip rcmd rsh-enable
157 ip rcmd remote-host smoke 192.168.1.2 smoke enable
158 !
159 Some IOS devices have a maximum of 5 VTYs available, so be careful not
161 to hit a limit with the 'forks' variable.
162 Password authentication
164 It is not possible to use password authentication with rsh or remsh due
165 to fundamental limitations of the protocol.
166 Ping packet size
168 The FPing manpage has the following to say on the topic of ping packet
169 size:
170 Number of bytes of ping data to send. The minimum size (normally 12)
172 allows room for the data that fping needs to do its work (sequence
173 number, timestamp). The reported received data size includes the IP
174 header (normally 20 bytes) and ICMP header (8 bytes), so the minimum
175 total size is 40 bytes. Default is 56, as in ping. Maximum is the
176 theoretical maximum IP datagram size (64K), though most systems limit
177 this to a smaller, system-dependent number.
1782.7.3 2021-03-11 Smokeping_probes_IOSPing(3)