1Smokeping_probes_IOSPing(3)        SmokePing       Smokeping_probes_IOSPing(3)
2
3
4

NAME

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

SYNOPSIS

9        *** Probes ***
10
11        +IOSPing
12
13        binary = /usr/bin/rsh # mandatory
14        forks = 5
15        offset = 50%
16        packetsize = 56
17        step = 300
18        timeout = 15
19
20        # The following variables can be overridden in each target section
21        /^influx_.+/ = influx_location = In the basement
22        ioshost = my.cisco.router # mandatory
23        iosint = Ethernet 1/0
24        iosuser = admin
25        pings = 5
26
27        # [...]
28
29        *** Targets ***
30
31        probe = IOSPing # if this should be the default probe
32
33        # [...]
34
35        + mytarget
36        # probe = IOSPing # if the default probe is something else
37        host = my.host
38        /^influx_.+/ = influx_location = In the basement
39        ioshost = my.cisco.router # mandatory
40        iosint = Ethernet 1/0
41        iosuser = admin
42        pings = 5
43

DESCRIPTION

45       Integrates Cisco IOS as a probe into smokeping.  Uses the rsh / remsh
46       protocol to run a ping from an IOS device.
47

VARIABLES

49       Supported probe-specific variables:
50
51       binary
52           The binary option specifies the path of the binary to be used to
53           connect to the IOS device.  Commonly used binaries are /usr/bin/rsh
54           and /usr/bin/remsh, although any script or binary should work if
55           can be called as
56
57               /path/to/binary [ -l user ] router ping
58
59           to produce the IOS ping dialog on stdin & stdout.
60
61           Example value: /usr/bin/rsh
62
63           This setting is mandatory.
64
65       forks
66           Run this many concurrent processes at maximum
67
68           Example value: 5
69
70           Default value: 5
71
72       offset
73           If you run many probes concurrently you may want to prevent them
74           from hitting your network all at the same time. Using the probe-
75           specific offset parameter you can change the point in time when
76           each probe will be run. Offset is specified in % of total interval,
77           or alternatively as 'random', and the offset from the 'General'
78           section is used if nothing is specified here. Note that this does
79           NOT influence the rrds itself, it is just a matter of when data
80           acquisition is initiated.  (This variable is only applicable if the
81           variable 'concurrentprobes' is set in the 'General' section.)
82
83           Example value: 50%
84
85       packetsize
86           The (optional) packetsize option lets you configure the packetsize
87           for the pings sent.
88
89           Default value: 56
90
91       step
92           Duration of the base interval that this probe should use, if
93           different from the one specified in the 'Database' section. Note
94           that the step in the RRD files is fixed when they are originally
95           generated, and if you change the step parameter afterwards, you'll
96           have to delete the old RRD files or somehow convert them. (This
97           variable is only applicable if the variable 'concurrentprobes' is
98           set in the 'General' section.)
99
100           Example value: 300
101
102       timeout
103           How long a single 'ping' takes at maximum
104
105           Example value: 15
106
107           Default value: 5
108
109       Supported target-specific variables:
110
111       /^influx_.+/
112           This is a tag that will be sent to influxdb and has no impact on
113           the probe measurement. The tag name will be sent without the
114           "influx_" prefix, which will be replaced with "tag_" instead. Tags
115           can be used for filtering.
116
117           Example value: influx_location = In the basement
118
119       ioshost
120           The ioshost option specifies the IOS device which should be used
121           for the ping.
122
123           Example value: my.cisco.router
124
125           This setting is mandatory.
126
127       iosint
128           The (optional) iosint option allows you to specify the source
129           address or interface in the IOS device. The value should be an IP
130           address or an interface name such as "Ethernet 1/0". If this option
131           is omitted, the IOS device will pick the IP address of the outbound
132           interface to use.
133
134           Example value: Ethernet 1/0
135
136       iosuser
137           The (optional) iosuser option allows you to specify the remote
138           username the IOS device.  If this option is omitted, the username
139           defaults to the default user used by the remsh command (usually the
140           user running the remsh command, ie the user running SmokePing).
141
142           Example value: admin
143
144       pings
145           How many pings should be sent to each target, if different from the
146           global value specified in the Database section. Note that the
147           number of pings in the RRD files is fixed when they are originally
148           generated, and if you change this parameter afterwards, you'll have
149           to delete the old RRD files or somehow convert them.
150
151           Example value: 5
152

AUTHORS

154       Paul J Murphy <paul@murph.org>
155
156       based on Smokeping::probes::FPing by
157
158       Tobias Oetiker <tobi@oetiker.ch>
159

NOTES

161   IOS Configuration
162       The IOS device must have rsh enabled and an appropriate trust defined,
163       eg:
164
165           !
166           ip rcmd rsh-enable
167           ip rcmd remote-host smoke 192.168.1.2 smoke enable
168           !
169
170       Some IOS devices have a maximum of 5 VTYs available, so be careful not
171       to hit a limit with the 'forks' variable.
172
173   Password authentication
174       It is not possible to use password authentication with rsh or remsh due
175       to fundamental limitations of the protocol.
176
177   Ping packet size
178       The FPing manpage has the following to say on the topic of ping packet
179       size:
180
181       Number of bytes of ping data to send.  The minimum size (normally 12)
182       allows room for the data that fping needs to do its work (sequence
183       number, timestamp).  The reported received data size includes the IP
184       header (normally 20 bytes) and ICMP header (8 bytes), so the minimum
185       total size is 40 bytes.  Default is 56, as in ping. Maximum is the
186       theoretical maximum IP datagram size (64K), though most systems limit
187       this to a smaller, system-dependent number.
188
189
190
1912.8.2                             2023-01-21       Smokeping_probes_IOSPing(3)
Impressum