1Smokeping_probes_SSH(3) SmokePing Smokeping_probes_SSH(3)
2
6 Smokeping::probes::SSH - Secure Shell Probe for SmokePing
7
9 *** Probes ***
10 +SSH
12 binary = /usr/bin/ssh-keyscan # mandatory
14 forks = 5
15 offset = 50%
16 step = 300
17 timeout = 15
18 # The following variables can be overridden in each target section
20 /^influx_.+/ = influx_location = In the basement
21 keytype = dsa
22 pings = 5
23 port = 5000
24 # [...]
26 *** Targets ***
28 probe = SSH # if this should be the default probe
30 # [...]
32 + mytarget
34 # probe = SSH # if the default probe is something else
35 host = my.host
36 /^influx_.+/ = influx_location = In the basement
37 keytype = dsa
38 pings = 5
39 port = 5000
40
42 Integrates ssh-keyscan as a probe into smokeping. The variable binary
43 must point to your copy of the ssh-keyscan program. If it is not
44 installed on your system yet, you should install openssh >= 3.8p1
45 The Probe asks the given host n-times for it's public key, where n is
47 the amount specified in the config File.
48 As part of the initialization, the probe asks 127.0.0.1 for it's public
50 key and tries to parse the output. Make sure you have SSH running on
51 the localhost as well.
52
54 Supported probe-specific variables:
55 binary
57 The location of your ssh-keyscan binary.
58 Example value: /usr/bin/ssh-keyscan
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 acquisition is initiated. (This variable is only applicable if the
79 variable 'concurrentprobes' is set in the 'General' section.)
80 Example value: 50%
82 step
84 Duration of the base interval that this probe should use, if
85 different from the one specified in the 'Database' section. Note
86 that the step in the RRD files is fixed when they are originally
87 generated, and if you change the step parameter afterwards, you'll
88 have to delete the old RRD files or somehow convert them. (This
89 variable is only applicable if the variable 'concurrentprobes' is
90 set in the 'General' section.)
91 Example value: 300
93 timeout
95 How long a single 'ping' takes at maximum
96 Example value: 15
98 Default value: 5
100 Supported target-specific variables:
102 /^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 Example value: influx_location = In the basement
110 keytype
112 Type of key, used in ssh-keyscan -t keytype
113 Example value: dsa
115 Default value: rsa
117 pings
119 How many pings should be sent to each target, if different from the
120 global value specified in the Database section. Note that the
121 number of pings in the RRD files is fixed when they are originally
122 generated, and if you change this parameter afterwards, you'll have
123 to delete the old RRD files or somehow convert them.
124 Example value: 5
126 port
128 Port to use when testing the ssh connection -p port
129 Example value: 5000
131 Default value: 22
133
135 Christian Recktenwald <smokeping-contact@citecs.de>
1362.8.2 2023-07-22 Smokeping_probes_SSH(3)