← Back to branch summary

~ubuntu-branches/debian/lenny/smokeping/lenny

« back to all changes in this revision

Viewing changes to doc/Smokeping/probes/AnotherSSH.pod

  • Committer: Bazaar Package Importer
  • Author(s): Niko Tyni
  • Date: 2006-10-26 21:45:56 UTC
  • mfrom: (1.2.2 upstream) (2.1.5 edgy)
  • Revision ID: james.westby@ubuntu.com-20061026214556-5jnpiesx4vdijmu6
http://bugs.debian.org/395056
* debian/patches/15_clean_makefile.dpatch:
  + remove unneeded and potentially unsecure include paths.
* debian/patches: selected patches from the upstream SVN repository
  + 40_password.dpatch: skip reading the password file when running as a CGI.
  + 50_ldap.dpatch: Make the 'scope' option in the LDAP probe actually work.
  + 60_fping.dpatch:
    * Support the '-S' (set source address, see #198486) fping option.
    * Don't try to execute fping when running as a CGI.
  + 70_syslog.dpatch: Don't die silently if syslogd is unavailable.
    (Closes: #395056)
* Remove all the autogenerated documentation at clean time, to properly
  undo the effects of the 'build' target.
* Install example configuration files for documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/Smokeping/probes/AnotherSSH.pod
 
1
=head1 NAME
 
2
 
 
3
Smokeping::probes::AnotherSSH - Another SSH probe
 
4
 
 
5
=head1 SYNOPSIS
 
6
 
 
7
 *** Probes ***
 
8
 
 
9
 +AnotherSSH
 
10
 
 
11
 forks = 5
 
12
 offset = 50%
 
13
 step = 300
 
14
 
 
15
 # The following variables can be overridden in each target section
 
16
 greeting = SSH-Latency-Measurement-Sorry-for-this-logmessage
 
17
 interval = established
 
18
 mininterval = 0.5
 
19
 pings = 5
 
20
 port = 22
 
21
 timeout = 5
 
22
 
 
23
 # [...]
 
24
 
 
25
 *** Targets ***
 
26
 
 
27
 probe = AnotherSSH # if this should be the default probe
 
28
 
 
29
 # [...]
 
30
 
 
31
 + mytarget
 
32
 # probe = AnotherSSH # if the default probe is something else
 
33
 host = my.host
 
34
 greeting = SSH-Latency-Measurement-Sorry-for-this-logmessage
 
35
 interval = established
 
36
 mininterval = 0.5
 
37
 pings = 5
 
38
 port = 22
 
39
 timeout = 5
 
40
 
 
41
=head1 DESCRIPTION
 
42
 
 
43
Latency measurement using SSH. This generates Logfile messages on the other 
 
44
Host, so get permission from the owner first! 
 
45
 
 
46
=head1 VARIABLES
 
47
 
 
48
Supported probe-specific variables:
 
49
 
 
50
=over
 
51
 
 
52
=item forks
 
53
 
 
54
Run this many concurrent processes at maximum
 
55
 
 
56
Example value: 5
 
57
 
 
58
Default value: 5
 
59
 
 
60
=item offset
 
61
 
 
62
If you run many probes concurrently you may want to prevent them from
 
63
hitting your network all at the same time. Using the probe-specific
 
64
offset parameter you can change the point in time when each probe will
 
65
be run. Offset is specified in % of total interval, or alternatively as
 
66
'random', and the offset from the 'General' section is used if nothing
 
67
is specified here. Note that this does NOT influence the rrds itself,
 
68
it is just a matter of when data acqusition is initiated.
 
69
(This variable is only applicable if the variable 'concurrentprobes' is set
 
70
in the 'General' section.)
 
71
 
 
72
Example value: 50%
 
73
 
 
74
=item step
 
75
 
 
76
Duration of the base interval that this probe should use, if different
 
77
from the one specified in the 'Database' section. Note that the step in
 
78
the RRD files is fixed when they are originally generated, and if you
 
79
change the step parameter afterwards, you'll have to delete the old RRD
 
80
files or somehow convert them. (This variable is only applicable if
 
81
the variable 'concurrentprobes' is set in the 'General' section.)
 
82
 
 
83
Example value: 300
 
84
 
 
85
=back
 
86
 
 
87
Supported target-specific variables:
 
88
 
 
89
=over
 
90
 
 
91
=item greeting
 
92
 
 
93
Greeting string to send to the SSH Server. This will appear in the Logfile. 
 
94
Use this to make clear, who you are and what you are doing to avoid confusion.
 
95
 
 
96
Also, don't use something that is a valid version string. This probe assumes
 
97
that the connection gets terminated because of protocol mismatch.
 
98
 
 
99
Default value: SSH-Latency-Measurement-Sorry-for-this-logmessage
 
100
 
 
101
=item interval
 
102
 
 
103
The interval to be measured. One of:
 
104
 
 
105
=over
 
106
 
 
107
=item connect
 
108
 
 
109
Interval between connect() and the greeting string from the host.
 
110
 
 
111
=item established
 
112
 
 
113
Interval between our greeting message and the end of the connection 
 
114
because of Protocol mismatch. This is the default.
 
115
 
 
116
=item complete
 
117
 
 
118
From connect() to the end of the connection.
 
119
 
 
120
=back
 
121
 
 
122
 
 
123
Default value: established
 
124
 
 
125
=item mininterval
 
126
 
 
127
Minimum interval between the start of two connection attempts in (possibly fractional) seconds.
 
128
 
 
129
Default value: 0.5
 
130
 
 
131
=item pings
 
132
 
 
133
How many pings should be sent to each target, if different from the global
 
134
value specified in the Database section. Note that the number of pings in
 
135
the RRD files is fixed when they are originally generated, and if you
 
136
change this parameter afterwards, you'll have to delete the old RRD
 
137
files or somehow convert them.
 
138
 
 
139
Example value: 5
 
140
 
 
141
=item port
 
142
 
 
143
Connect to this port.
 
144
 
 
145
Default value: 22
 
146
 
 
147
=item timeout
 
148
 
 
149
Timeout for the connection.
 
150
 
 
151
Default value: 5
 
152
 
 
153
=back
 
154
 
 
155
 
 
156
=head1 AUTHORS
 
157
 
 
158
Christoph Heine <Christoph.Heine@HaDiKo.DE>
 
159
 
 
160
=cut
 
 
b'\\ No newline at end of file'