1Smokeping_probes_OpenSSHJunOSPing(3)SmokePinSgmokeping_probes_OpenSSHJunOSPing(3)
2
3
4

NAME

6       Smokeping::probes::OpenSSHJunOSPing - Juniper SSH JunOS Probe for
7       SmokePing
8

SYNOPSIS

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

DESCRIPTION

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

AUTHORS

160       Tobias Oetiker <tobi@oetiker.ch>
161
162       based on Smokeping::probes::TelnetJunOSPing by S H A N
163       <shanali@yahoo.com>.
164

NOTES

166   JunOS configuration
167       The JunOS device should have a username/password configured, as well as
168       the ability to connect to the VTY(s).
169
170       Make sure to connect to the remote host once from the command line as
171       the user who is running smokeping. On the first connect ssh will ask to
172       add the new host to its known_hosts file. This will not happen
173       automatically so the script will fail to login until the ssh key of
174       your juniper box is in the known_hosts file.
175
176       Some JunOS devices have a maximum of 5 VTYs available, so be careful
177       not to hit a limit with the 'forks' variable.
178
179   Requirements
180       This module requires the  Net::OpenSSH and IO::Pty.
181
182
183
1842.8.2                             2022-01-2S2mokeping_probes_OpenSSHJunOSPing(3)
Impressum