1Smokeping_probes_SSH(3)            SmokePing           Smokeping_probes_SSH(3)
2
3
4

NAME

6       Smokeping::probes::SSH - Secure Shell Probe for SmokePing
7

SYNOPSIS

9        *** Probes ***
10
11        +SSH
12
13        binary = /usr/bin/ssh-keyscan # mandatory
14        forks = 5
15        offset = 50%
16        step = 300
17        timeout = 15
18
19        # The following variables can be overridden in each target section
20        keytype = dsa
21        pings = 5
22        port = 5000
23
24        # [...]
25
26        *** Targets ***
27
28        probe = SSH # if this should be the default probe
29
30        # [...]
31
32        + mytarget
33        # probe = SSH # if the default probe is something else
34        host = my.host
35        keytype = dsa
36        pings = 5
37        port = 5000
38

DESCRIPTION

40       Integrates ssh-keyscan as a probe into smokeping. The variable binary
41       must point to your copy of the ssh-keyscan program. If it is not
42       installed on your system yet, you should install openssh >= 3.8p1
43
44       The Probe asks the given host n-times for it's public key, where n is
45       the amount specified in the config File.
46
47       As part of the initialization, the probe asks 127.0.0.1 for it's public
48       key and tries to parse the output. Make sure you have SSH running on
49       the localhost as well.
50

VARIABLES

52       Supported probe-specific variables:
53
54       binary
55           The location of your ssh-keyscan binary.
56
57           Example value: /usr/bin/ssh-keyscan
58
59           This setting is mandatory.
60
61       forks
62           Run this many concurrent processes at maximum
63
64           Example value: 5
65
66           Default value: 5
67
68       offset
69           If you run many probes concurrently you may want to prevent them
70           from hitting your network all at the same time. Using the probe-
71           specific offset parameter you can change the point in time when
72           each probe will be run. Offset is specified in % of total interval,
73           or alternatively as 'random', and the offset from the 'General'
74           section is used if nothing is specified here. Note that this does
75           NOT influence the rrds itself, it is just a matter of when data
76           acqusition is initiated.  (This variable is only applicable if the
77           variable 'concurrentprobes' is set in the 'General' section.)
78
79           Example value: 50%
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       keytype
102           Type of key, used in ssh-keyscan -t keytype
103
104           Example value: dsa
105
106           Default value: rsa
107
108       pings
109           How many pings should be sent to each target, if different from the
110           global value specified in the Database section. Note that the
111           number of pings in the RRD files is fixed when they are originally
112           generated, and if you change this parameter afterwards, you'll have
113           to delete the old RRD files or somehow convert them.
114
115           Example value: 5
116
117       port
118           Port to use when testing the ssh connection -p port
119
120           Example value: 5000
121
122           Default value: 22
123

AUTHORS

125       Christian Recktenwald <smokeping-contact@citecs.de>
126
127
128
1292.7.2                             2019-07-26           Smokeping_probes_SSH(3)