1Smokeping_probes_OpenSSHEOSPing(3) SmokePingSmokeping_probes_OpenSSHEOSPing(3)
2
6 Smokeping::probes::OpenSSHEOSPing - Arista EOS SSH Probe for SmokePing
7
9 *** Probes ***
10 +OpenSSHEOSPing
12 forks = 5
14 offset = 50%
15 packetsize = 100
16 step = 300
17 timeout = 15
18 # The following variables can be overridden in each target section
20 eospass = password # mandatory
21 eosuser = user # mandatory
22 pings = 5
23 psource = 192.168.2.129
24 source = 192.168.2.1 # mandatory
25 unpriv = 1
26 # [...]
28 *** Targets ***
30 probe = OpenSSHEOSPing # if this should be the default probe
32 # [...]
34 + mytarget
36 # probe = OpenSSHEOSPing # if the default probe is something else
37 host = my.host
38 eospass = password # mandatory
39 eosuser = user # mandatory
40 pings = 5
41 psource = 192.168.2.129
42 source = 192.168.2.1 # mandatory
43 unpriv = 1
44
46 Connect to Arista EOS via OpenSSH to run ping commands. This probe
47 uses the "ping" cli of the Arista EOS. You have the option to specify
48 which interface the ping is sourced from as well.
49
51 Supported probe-specific variables:
52 forks
54 Run this many concurrent processes at maximum
55 Example value: 5
57 Default value: 5
59 offset
61 If you run many probes concurrently you may want to prevent them
62 from hitting your network all at the same time. Using the probe-
63 specific offset parameter you can change the point in time when
64 each probe will be run. Offset is specified in % of total interval,
65 or alternatively as 'random', and the offset from the 'General'
66 section is used if nothing is specified here. Note that this does
67 NOT influence the rrds itself, it is just a matter of when data
68 acqusition is initiated. (This variable is only applicable if the
69 variable 'concurrentprobes' is set in the 'General' section.)
70 Example value: 50%
72 packetsize
74 The (optional) packetsize option lets you configure the packetsize
75 for the pings sent.
76 Default value: 100
78 step
80 Duration of the base interval that this probe should use, if
81 different from the one specified in the 'Database' section. Note
82 that the step in the RRD files is fixed when they are originally
83 generated, and if you change the step parameter afterwards, you'll
84 have to delete the old RRD files or somehow convert them. (This
85 variable is only applicable if the variable 'concurrentprobes' is
86 set in the 'General' section.)
87 Example value: 300
89 timeout
91 How long a single 'ping' takes at maximum
92 Example value: 15
94 Default value: 5
96 Supported target-specific variables:
98 eospass
100 The eospass option allows you to specify the password for the
101 username specified with the option eosuser.
102 Example value: password
104 This setting is mandatory.
106 eosuser
108 The eosuser option allows you to specify a username that has ping
109 capability on the EOS Device.
110 Example value: user
112 This setting is mandatory.
114 pings
116 How many pings should be sent to each target, if different from the
117 global value specified in the Database section. Note that the
118 number of pings in the RRD files is fixed when they are originally
119 generated, and if you change this parameter afterwards, you'll have
120 to delete the old RRD files or somehow convert them.
121 Example value: 5
123 psource
125 The (optional) psource option specifies an alternate IP address or
126 Interface from which you wish to source your pings from. Routers
127 can have many many IP addresses, and interfaces. When you ping
128 from a router you have the ability to choose which interface and/or
129 which IP address the ping is sourced from. Specifying an
130 IP/interface does not necessarily specify the interface from which
131 the ping will leave, but will specify which address the packet(s)
132 appear to come from. If this option is left out the EOS Device
133 will source the packet automatically based on routing and/or
134 metrics. If this doesn't make sense to you then just leave it out.
135 Example value: 192.168.2.129
137 source
139 The source option specifies the EOS device that is going to run the
140 ping commands. This address will be used for the ssh connection.
141 Example value: 192.168.2.1
143 This setting is mandatory.
145 unpriv
147 If the account is unprivileged, specify the 'unpriv' option. You
148 must also configure "pings = 5", since that is the only value
149 supported, and values specified for packetsize or psource are
150 ignored.
151 Example value: 1
153
155 Bill Fenner <fenner@aristanetworks.com>
156 based on Smokeping::Probes::OpenSSHJunOSPing by Tobias Oetiker
158 <tobi@oetiker.ch>, which itself is based on
159 Smokeping::probes::TelnetJunOSPing by S H A N <shanali@yahoo.com>.
160
162 EOS configuration
163 The EOS device should have a username/password configured, and the ssh
164 server must not be disabled.
165 Make sure to connect to the remote host once from the commmand line as
167 the user who is running smokeping. On the first connect ssh will ask to
168 add the new host to its known_hosts file. This will not happen
169 automatically so the script will fail to login until the ssh key of
170 your EOS box is in the known_hosts file.
171 Requirements
173 This module requires the Net::OpenSSH and IO::Pty perl modules.
1742.7.3 2021-03-11Smokeping_probes_OpenSSHEOSPing(3)