1Smokeping_probes_AnotherSSH(3)     SmokePing    Smokeping_probes_AnotherSSH(3)
2
3
4

NAME

6       Smokeping::probes::AnotherSSH - Another SSH probe
7

SYNOPSIS

9        *** Probes ***
10
11        +AnotherSSH
12
13        forks = 5
14        offset = 50%
15        step = 300
16
17        # The following variables can be overridden in each target section
18        /^influx_.+/ = influx_location = In the basement
19        greeting = SSH-Latency-Measurement-Sorry-for-this-logmessage
20        interval = established
21        mininterval = 0.5
22        pings = 5
23        port = 22
24        timeout = 5
25
26        # [...]
27
28        *** Targets ***
29
30        probe = AnotherSSH # if this should be the default probe
31
32        # [...]
33
34        + mytarget
35        # probe = AnotherSSH # if the default probe is something else
36        host = my.host
37        /^influx_.+/ = influx_location = In the basement
38        greeting = SSH-Latency-Measurement-Sorry-for-this-logmessage
39        interval = established
40        mininterval = 0.5
41        pings = 5
42        port = 22
43        timeout = 5
44

DESCRIPTION

46       Latency measurement using SSH. This generates Logfile messages on the
47       other Host, so get permission from the owner first!
48

VARIABLES

50       Supported probe-specific variables:
51
52       forks
53           Run this many concurrent processes at maximum
54
55           Example value: 5
56
57           Default value: 5
58
59       offset
60           If you run many probes concurrently you may want to prevent them
61           from hitting your network all at the same time. Using the probe-
62           specific offset parameter you can change the point in time when
63           each probe will be run. Offset is specified in % of total interval,
64           or alternatively as 'random', and the offset from the 'General'
65           section is used if nothing is specified here. Note that this does
66           NOT influence the rrds itself, it is just a matter of when data
67           acquisition is initiated.  (This variable is only applicable if the
68           variable 'concurrentprobes' is set in the 'General' section.)
69
70           Example value: 50%
71
72       step
73           Duration of the base interval that this probe should use, if
74           different from the one specified in the 'Database' section. Note
75           that the step in the RRD files is fixed when they are originally
76           generated, and if you change the step parameter afterwards, you'll
77           have to delete the old RRD files or somehow convert them. (This
78           variable is only applicable if the variable 'concurrentprobes' is
79           set in the 'General' section.)
80
81           Example value: 300
82
83       Supported target-specific variables:
84
85       /^influx_.+/
86           This is a tag that will be sent to influxdb and has no impact on
87           the probe measurement. The tag name will be sent without the
88           "influx_" prefix, which will be replaced with "tag_" instead. Tags
89           can be used for filtering.
90
91           Example value: influx_location = In the basement
92
93       greeting
94           Greeting string to send to the SSH Server. This will appear in the
95           Logfile.  Use this to make clear, who you are and what you are
96           doing to avoid confusion.
97
98           Also, don't use something that is a valid version string. This
99           probe assumes that the connection gets terminated because of
100           protocol mismatch.
101
102           Default value: SSH-Latency-Measurement-Sorry-for-this-logmessage
103
104       interval
105           The interval to be measured. One of:
106
107           connect
108               Interval between connect() and the greeting string from the
109               host.
110
111           established
112               Interval between our greeting message and the end of the
113               connection because of Protocol mismatch. This is the default.
114
115           complete
116               From connect() to the end of the connection.
117
118           Default value: established
119
120       mininterval
121           Minimum interval between the start of two connection attempts in
122           (possibly fractional) seconds.
123
124           Default value: 0.5
125
126       pings
127           How many pings should be sent to each target, if different from the
128           global value specified in the Database section. Note that the
129           number of pings in the RRD files is fixed when they are originally
130           generated, and if you change this parameter afterwards, you'll have
131           to delete the old RRD files or somehow convert them.
132
133           Example value: 5
134
135       port
136           Connect to this port.
137
138           Default value: 22
139
140       timeout
141           Timeout for the connection.
142
143           Default value: 5
144

AUTHORS

146       Christoph Heine <Christoph.Heine@HaDiKo.DE>
147
148
149
1502.8.2                             2023-01-21    Smokeping_probes_AnotherSSH(3)