59
59
DDEESSCCRRIIPPTTIIOONN
60
This probe measures LDAP query latency for SmokePing. The
61
query is specified by the target-specific variable `fil-
62
ter' and, optionally, by the target-specific variable
63
`base'. The attributes queried can be specified in the
64
comma-separated list `attrs'.
66
The TCP port of the LDAP server and the LDAP version to be
67
used can be specified by the variables `port' and `ver-
70
The probe can issue the starttls command to convert the
71
connection into encrypted mode, if so instructed by the
72
`start_tls' variable. This requires the 'IO::Socket::SSL'
73
perl module to be installed.
75
The probe can also optionally do an authenticated LDAP
76
bind, if the `binddn' variable is present. The password to
77
be used can be specified by the target-specific variable
78
`password' or in an external file. The location of this
79
file is given in the probe-specific variable `password-
80
file'. See _S_m_o_k_e_p_i_n_g_:_:_p_r_o_b_e_s_:_:_p_a_s_s_w_o_r_d_c_h_e_c_k_e_r(3pm) for the
81
format of this file (summary: colon-separated triplets of
82
the form `<host>:<bind-dn>:<password>')
84
The probe tries to be nice to the server and does not send
85
authentication requests more frequently than once every X
86
seconds, where X is the value of the target-specific
87
"min_interval" variable (1 by default).
60
This probe measures LDAP query latency for SmokePing. The query is
61
specified by the target-specific variable `filter' and, optionally, by
62
the target-specific variable `base'. The attributes queried can be
63
specified in the comma-separated list `attrs'.
65
The TCP port of the LDAP server and the LDAP version to be used can be
66
specified by the variables `port' and `version'.
68
The probe can issue the starttls command to convert the connection into
69
encrypted mode, if so instructed by the `start_tls' variable. This
70
requires the 'IO::Socket::SSL' perl module to be installed.
72
The probe can also optionally do an authenticated LDAP bind, if the
73
`binddn' variable is present. The password to be used can be specified
74
by the target-specific variable `password' or in an external file. The
75
location of this file is given in the probe-specific variable `pass-
76
wordfile'. See _S_m_o_k_e_p_i_n_g_:_:_p_r_o_b_e_s_:_:_p_a_s_s_w_o_r_d_c_h_e_c_k_e_r(3pm) for the format
77
of this file (summary: colon-separated triplets of the form
78
`<host>:<bind-dn>:<password>')
80
The probe tries to be nice to the server and does not send authentica-
81
tion requests more frequently than once every X seconds, where X is the
82
value of the target-specific "min_interval" variable (1 by default).
90
85
Supported probe-specific variables:
100
If you run many probes concurrently you may want to
101
prevent them from hitting your network all at the same
102
time. Using the probe-specific offset parameter you
103
can change the point in time when each probe will be
104
run. Offset is specified in % of total interval, or
105
alternatively as 'random', and the offset from the
106
'General' section is used if nothing is specified
107
here. Note that this does NOT influence the rrds
108
itself, it is just a matter of when data acqusition is
109
initiated. (This variable is only applicable if the
110
variable 'concurrentprobes' is set in the 'General'
95
If you run many probes concurrently you may want to prevent them
96
from hitting your network all at the same time. Using the probe-
97
specific offset parameter you can change the point in time when
98
each probe will be run. Offset is specified in % of total interval,
99
or alternatively as 'random', and the offset from the 'General'
100
section is used if nothing is specified here. Note that this does
101
NOT influence the rrds itself, it is just a matter of when data
102
acqusition is initiated. (This variable is only applicable if the
103
variable 'concurrentprobes' is set in the 'General' section.)
113
105
Example value: 50%
116
Location of the file containing usernames and pass-
108
Location of the file containing usernames and passwords.
119
110
Example value: /some/place/secret
122
Duration of the base interval that this probe should
123
use, if different from the one specified in the
124
'Database' section. Note that the step in the RRD
125
files is fixed when they are originally generated, and
126
if you change the step parameter afterwards, you'll
127
have to delete the old RRD files or somehow convert
128
them. (This variable is only applicable if the vari-
129
able 'concurrentprobes' is set in the 'General' sec-
113
Duration of the base interval that this probe should use, if dif-
114
ferent from the one specified in the 'Database' section. Note that
115
the step in the RRD files is fixed when they are originally gener-
116
ated, and if you change the step parameter afterwards, you'll have
117
to delete the old RRD files or somehow convert them. (This variable
118
is only applicable if the variable 'concurrentprobes' is set in the
132
121
Example value: 300
156
145
This setting is mandatory.
159
The minimum interval between each query sent, in (pos-
160
sibly fractional) second s.
148
The minimum interval between each query sent, in (possibly frac-
165
The password to be used, if not present in <password-
154
The password to be used, if not present in <passwordfile>.
168
156
Example value: mypass
171
How many pings should be sent to each target, if dif-
172
ferent from the global value specified in the Database
173
section. Note that the number of pings in the RRD
174
files is fixed when they are originally generated, and
175
if you change this parameter afterwards, you'll have
159
How many pings should be sent to each target, if different from the
160
global value specified in the Database section. Note that the num-
161
ber of pings in the RRD files is fixed when they are originally
162
generated, and if you change this parameter afterwards, you'll have
176
163
to delete the old RRD files or somehow convert them.
183
170
Example value: 389
186
The scope of the query. Can be either 'base', 'one' or
187
'sub'. See the Net::LDAP documentation for details.
173
The scope of the query. Can be either 'base', 'one' or 'sub'. See
174
the Net::LDAP documentation for details.
189
176
Example value: one
191
178
Default value: sub
194
If true, encrypt the connection with the starttls com-
195
mand. Disabled by default.
181
If true, encrypt the connection with the starttls command. Disabled
212
199
Niko Tyni <ntyni@iki.fi>
215
There should be a way of specifying TLS options, such as
216
the certificates involved etc.
218
The probe has an ugly way of working around the fact that
219
the IO::Socket::SSL class complains if _s_t_a_r_t___t_l_s_(_) is done
220
more than once in the same program. But It Works For Me
225
2.0.9 2006-07d-o1c4::Smokeping::probes::LDAP(3)
202
There should be a way of specifying TLS options, such as the certifi-
205
The probe has an ugly way of working around the fact that the
206
IO::Socket::SSL class complains if _s_t_a_r_t___t_l_s_(_) is done more than once
207
in the same program. But It Works For Me (tm).
211
2.3.6 2008-04-26 doc::Smokeping::probes::LDAP(3)
added
removed
doc/Smokeping/probes/LDAP.txt
