From: Marc Fournier <marc.fournier@camptocamp.com>
Date: Wed, 20 Aug 2014 11:58:12 +0000 (+0200)
Subject: openldap: documentation improvements
X-Git-Tag: collectd-5.5.0~152^2~7
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=6b8401711a5a51f968ce6ab8987db5f2e20cca94;p=collectd.git

openldap: documentation improvements
---

diff --git a/src/collectd.conf.in b/src/collectd.conf.in
index 21de8440..b7f7b747 100644
--- a/src/collectd.conf.in
+++ b/src/collectd.conf.in
@@ -143,6 +143,7 @@
 #@BUILD_PLUGIN_NUT_TRUE@LoadPlugin nut
 #@BUILD_PLUGIN_OLSRD_TRUE@LoadPlugin olsrd
 #@BUILD_PLUGIN_ONEWIRE_TRUE@LoadPlugin onewire
+#@BUILD_PLUGIN_OPENLDAP_TRUE@LoadPlugin openldap
 #@BUILD_PLUGIN_OPENVPN_TRUE@LoadPlugin openvpn
 #@BUILD_PLUGIN_ORACLE_TRUE@LoadPlugin oracle
 #@BUILD_PLUGIN_PERL_TRUE@<LoadPlugin perl>
@@ -754,6 +755,17 @@
 #	IgnoreSelected false
 #</Plugin>
 
+#<Plugin openldap>
+#  <Instance "localhost">
+#    URL "ldap://localhost:389"
+#    StartTLS false
+#    VerifyHost true
+#    CACert "/path/to/ca.crt"
+#    Timeout -1
+#    Version 3
+#  </Instance>
+#</Plugin>
+
 #<Plugin openvpn>
 #	StatusFile "/etc/openvpn/openvpn-status.log"
 #	ImprovedNamingSchema false
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 74fb19fe..9ca48b2a 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -4231,19 +4231,19 @@ plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
 
 =head2 Plugin C<openldap>
 
-To configure the C<openldap>-plugin you first need to configure the OpenLDAP
+To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
 server correctly. The backend database C<monitor> needs to be loaded and
-working.
+working. See slapd-monitor(5) for the details.
 
-The configuration of the I<openldap> plugin consists of one or more
-C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
-as the instance name. For example:
+The configuration of the C<openldap> plugin consists of one or more B<Instance>
+blocks. Each block requires one string argument as the instance name. For
+example:
 
  <Plugin "openldap">
-   <Instance "">
+   <Instance "foo">
      URL "ldap://localhost/"
    </Instance>
-   <Instance "">
+   <Instance "bar">
      URL "ldaps://localhost/"
    </Instance>
  </Plugin>
@@ -4251,38 +4251,46 @@ as the instance name. For example:
 The instance name will be used as the I<plugin instance>. To emulate the old
 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
 plugin to work correctly, each instance name must be unique. This is not
-enforced by the plugin and it is your responsibility to ensure it.
+enforced by the plugin and it is your responsibility to ensure it is.
 
-The following options are accepted within each I<Instance> block:
+The following options are accepted within each B<Instance> block:
 
 =over 4
 
 =item B<URL> I<ldap://host/binddn>
 
-Sets the URL of the C<openldap> server. This option is I<mandatory>.
+Sets the URL to use to connect to the I<OpenLDAP> server. This option is
+I<mandatory>.
 
 =item B<StartTLS> B<true|false>
 
-If the ldap server requires tls, set this. Disabled by default.
+Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
+Disabled by default.
 
 =item B<VerifyHost> B<true|false>
 
-Enable or disable peer host name verification. If enabled, the plugin checks
+Enables or disables peer host name verification. If enabled, the plugin checks
 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
 certificate matches the host name provided by the B<URL> option. If this
 identity check fails, the connection is aborted. Enabled by default.
 
 =item B<CACert> I<File>
 
-File that holds one or more SSL certificates. If you want to use TLS/SSL you may
-possibly need this option. What CA certificates come bundled with C<libldap>
-and are checked by default depends on the distribution you use.
+File that holds one or more SSL certificates. If you want to use TLS/SSL you
+may possibly need this option. What CA certificates are checked by default
+depends on the distribution you use and can be changed with the usual ldap
+client configuration mechanisms. See ldap.conf(5) for the details.
 
 =item B<Timeout> I<Seconds>
 
-Set the timeout value for ldap operations. Defaults to B<-1> which results in
+Sets the timeout value for ldap operations. Defaults to B<-1> which results in
 an infinite timeout.
 
+=item B<Version> I<Version>
+
+An integer which sets the LDAP protocol version number to use when connecting
+to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
+
 =back
 
 =head2 Plugin C<openvpn>