1Smokeping_probes_OpenSSHEOSPing(3) SmokePingSmokeping_probes_OpenSSHEOSPing(3)
2
3
4

NAME

6       Smokeping::probes::OpenSSHEOSPing - Arista EOS SSH Probe for SmokePing
7

SYNOPSIS

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

DESCRIPTION

48       Connect to Arista EOS via OpenSSH to run ping commands.  This probe
49       uses the "ping" cli of the Arista EOS.  You have the option to specify
50       which interface the ping is 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           acquisition 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: 100
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       /^influx_.+/
102           This is a tag that will be sent to influxdb and has no impact on
103           the probe measurement. The tag name will be sent without the
104           "influx_" prefix, which will be replaced with "tag_" instead. Tags
105           can be used for filtering.
106
107           Example value: influx_location = In the basement
108
109       eospass
110           The eospass option allows you to specify the password for the
111           username specified with the option eosuser.
112
113           Example value: password
114
115           This setting is mandatory.
116
117       eosuser
118           The eosuser option allows you to specify a username that has ping
119           capability on the EOS Device.
120
121           Example value: user
122
123           This setting is mandatory.
124
125       pings
126           How many pings should be sent to each target, if different from the
127           global value specified in the Database section. Note that the
128           number of pings in the RRD files is fixed when they are originally
129           generated, and if you change this parameter afterwards, you'll have
130           to delete the old RRD files or somehow convert them.
131
132           Example value: 5
133
134       psource
135           The (optional) psource option specifies an alternate IP address or
136           Interface from which you wish to source your pings from.  Routers
137           can have many many IP addresses, and interfaces.  When you ping
138           from a router you have the ability to choose which interface and/or
139           which IP address the ping is sourced from.  Specifying an
140           IP/interface does not necessarily specify the interface from which
141           the ping will leave, but will specify which address the packet(s)
142           appear to come from.  If this option is left out the EOS Device
143           will source the packet automatically based on routing and/or
144           metrics.  If this doesn't make sense to you then just leave it out.
145
146           Example value: 192.168.2.129
147
148       source
149           The source option specifies the EOS device that is going to run the
150           ping commands.  This address will be used for the ssh connection.
151
152           Example value: 192.168.2.1
153
154           This setting is mandatory.
155
156       unpriv
157           If the account is unprivileged, specify the 'unpriv' option.  You
158           must also configure "pings = 5", since that is the only value
159           supported, and values specified for packetsize or psource are
160           ignored.
161
162           Example value: 1
163

AUTHORS

165       Bill Fenner <fenner@aristanetworks.com>
166
167       based on Smokeping::Probes::OpenSSHJunOSPing by Tobias Oetiker
168       <tobi@oetiker.ch>, which itself is based on
169       Smokeping::probes::TelnetJunOSPing by S H A N <shanali@yahoo.com>.
170

NOTES

172   EOS configuration
173       The EOS device should have a username/password configured, and the ssh
174       server must not be disabled.
175
176       Make sure to connect to the remote host once from the command line as
177       the user who is running smokeping. On the first connect ssh will ask to
178       add the new host to its known_hosts file. This will not happen
179       automatically so the script will fail to login until the ssh key of
180       your EOS box is in the known_hosts file.
181
182   Requirements
183       This module requires the  Net::OpenSSH and IO::Pty perl modules.
184
185
186
1872.8.2                             2023-07-22Smokeping_probes_OpenSSHEOSPing(3)
Impressum