From: Florian Forster <octo@huhu.verplant.org>
Date: Sun, 29 Nov 2009 15:14:05 +0000 (+0100)
Subject: collectd.conf(5): Add section about the "routeros" plugin.
X-Git-Tag: collectd-4.9.0~36^2~3
X-Git-Url: https://git.octo.it/?a=commitdiff_plain;h=5d4b55229b912b8a1187ec4fd6d84841d52adfeb;p=collectd.git

collectd.conf(5): Add section about the "routeros" plugin.
---

diff --git a/README b/README
index d40fd2f0..47499f1f 100644
--- a/README
+++ b/README
@@ -552,6 +552,10 @@ Prerequisites
     The PostgreSQL C client library used by the `postgresql' plugin.
     <http://www.postgresql.org/>
 
+  * librouteros (optional)
+    Used by the `routeros' plugin to connect to a device running `RouterOS'.
+    <http://verplant.org/librouteros/>
+
   * librrd (optional)
     Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
     client support which was added after version 1.3 of RRDtool. Versions 1.0,
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 6bae3393..6609e692 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -3281,6 +3281,53 @@ matching values will be ignored.
 
 =back
 
+=head2 Plugin C<routeros>
+
+The C<routeros> plugin connects to a device running I<RouterOS>, the
+Linux-based operating system for routers by I<MikroTik>. The plugin uses
+I<librouteros> to connect and reads information about the interfaces and
+wireless connections of the device. The configuration supports querying
+multiple routers:
+
+  <Plugin "routeros">
+    <Router>
+      Host "router0.example.com"
+      User "collectd"
+      Password "secr3t"
+    </Router>
+    <Router>
+      Host "router1.example.com"
+      User "collectd"
+      Password "5ecret"
+    </Router>
+  </Plugin>
+
+As you can see above, the configuration of the I<routeros> plugin consists of
+one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
+options are understood:
+
+=over 4
+
+=item B<Host> I<Host>
+
+Hostname or IP-address of the router to connect to.
+
+=item B<Port> I<Port>
+
+Port name or port number used when connecting. If left unspecified, the default
+will be chosen by I<librouteros>, currently "8728". This option expects a
+string argument, even when a numeric port number is given.
+
+=item B<User> I<User>
+
+Use the user name I<User> to authenticate. Defaults to "admin".
+
+=item B<Password> I<Password>
+
+Set the password used to authenticate.
+
+=back
+
 =head2 Plugin C<rrdcached>
 
 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,