← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/probes/LDAP.pm.html

  • 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/probes/LDAP.pm.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2
 
<html xmlns="http://www.w3.org/1999/xhtml">
3
 
<head>
4
 
<title>probes/LDAP.pm</title>
5
 
<link rev="made" href="mailto:dws@ee.ethz.ch" />
6
 
</head>
7
 
 
8
 
<body style="background-color: white">
9
 
 
10
 
<p><a name="__index__"></a></p>
11
 
<!-- INDEX BEGIN -->
12
 
<!--
13
 
 
14
 
<ul>
15
 
 
16
 
        <li><a href="#name">NAME</a></li>
17
 
        <li><a href="#overview">OVERVIEW</a></li>
18
 
        <li><a href="#synopsys">SYNOPSYS</a></li>
19
 
        <li><a href="#author">AUTHOR</a></li>
20
 
        <li><a href="#bugs">BUGS</a></li>
21
 
</ul>
22
 
-->
23
 
<!-- INDEX END -->
24
 
 
25
 
<p>
26
 
</p>
27
 
<h1><a name="name">NAME</a></h1>
28
 
<p>probes::LDAP - a LDAP probe for SmokePing</p>
29
 
<p>
30
 
</p>
31
 
<hr />
32
 
<h1><a name="overview">OVERVIEW</a></h1>
33
 
<p>Measures LDAP search latency for SmkoePing</p>
34
 
<p>
35
 
</p>
36
 
<hr />
37
 
<h1><a name="synopsys">SYNOPSYS</a></h1>
38
 
<pre>
39
 
 *** Probes ***
40
 
 + LDAP</pre>
41
 
<pre>
42
 
 passwordfile = /usr/share/smokeping/etc/password # optional
43
 
 sleeptime = 0.5 # optional, 1 second by default</pre>
44
 
<pre>
45
 
 *** Targets ***</pre>
46
 
<pre>
47
 
 probe = LDAP</pre>
48
 
<pre>
49
 
 + PROBE_CONF
50
 
 port = 389 # optional
51
 
 version = 3 # optional
52
 
 start_tls = 1 # disabled by default
53
 
 timeout = 60 # optional
54
 
 
55
 
 base = dc=foo,dc=bar # optional
56
 
 filter = uid=testuser # the actual search
57
 
 attrs = uid,someotherattr
58
 
 
59
 
 # if binddn isn't present, the LDAP bind is unauthenticated
60
 
 binddn = uid=testuser,dc=foo,dc=bar  
61
 
 password = mypass # if not present in &lt;passwordfile&gt;
62
 
  
63
 
=head1 DESCRIPTION</pre>
64
 
<p>This probe measures LDAP query latency for SmokePing.
65
 
The query is specified by the target-specific variable `filter' and,
66
 
optionally, by the target-specific variable `base'. The attributes 
67
 
queried can be specified in the comma-separated list `attrs'.</p>
68
 
<p>The TCP port of the LDAP server and the LDAP version to be used can
69
 
be specified by the variables `port' and `version'.</p>
70
 
<p>The probe can issue the starttls command to convert the connection
71
 
into encrypted mode, if so instructed by the `start_tls' variable.
72
 
It can also optionally do an authenticated LDAP bind, if the `binddn'
73
 
variable is present. The password to be used can be specified by the
74
 
target-specific variable `password' or in an external file.
75
 
The location of this file is given in the probe-specific variable
76
 
`passwordfile'. See probes::passwordchecker(3pm) for the format
77
 
of this file (summary: colon-separated triplets of the form
78
 
`&lt;host&gt;:&lt;bind-dn&gt;:&lt;password&gt;')</p>
79
 
<p>The probe tries to be nice to the server and sleeps for the probe-specific
80
 
variable `sleeptime' (one second by default) between each authentication
81
 
request.</p>
82
 
<p>
83
 
</p>
84
 
<hr />
85
 
<h1><a name="author">AUTHOR</a></h1>
86
 
<p>Niko Tyni &lt;<a href="mailto:ntyni@iki.fi">ntyni@iki.fi</a>&gt;</p>
87
 
<p>
88
 
</p>
89
 
<hr />
90
 
<h1><a name="bugs">BUGS</a></h1>
91
 
<p>There should be a way of specifying TLS options, such as the certificates
92
 
involved etc.</p>
93
 
<p>The probe has an ugly way of working around the fact that the 
94
 
IO::Socket::SSL class complains if <code>start_tls()</code> is done more than once
95
 
in the same program. But It Works For Me (tm).</p>
96
 
 
97
 
</body>
98
 
 
99
 
</html>