Code

doc: Added documentation for all existing plugins.
[sysdb.git] / doc / sysdbd-mk-livestatus.5.txt
diff --git a/doc/sysdbd-mk-livestatus.5.txt b/doc/sysdbd-mk-livestatus.5.txt
new file mode 100644 (file)
index 0000000..a39c39c
--- /dev/null
@@ -0,0 +1,62 @@
+sysdbd-mk-livestatus(5)
+=======================
+Sebastian "tokkee" Harl <sh@tokkee.org>
+version {package_version}, {build_date}
+:doctype: manpage
+
+NAME
+----
+sysdbd-mk-livestatus - mk-livestatus plugin querying monitoring systems
+
+SYNOPSIS
+--------
+  <LoadBackend "mk-livestatus">
+      Interval 300
+  </LoadBackend>
+
+  <Backend "mk-livestatus">
+      <Instance "collector">
+          Socket "/var/lib/nagios4/rw/live"
+      </Instance>
+  </Backend>
+
+DESCRIPTION
+-----------
+*mk-livestatus* is a backend module which queries monitoring systems
+supporting the Check_MK livestatus interface (e.g. Icinga, Naemon, Nagios,
+Shinken). It connects to the monitoring daemon and periodically queries all
+hosts and services.
+
+CONFIGURATION
+-------------
+*mk-livestatus* accepts the following configuration options:
+
+*Instance* '<name>'::
+       An instance block specifies a connection to the monitoring system. The
+       specified '<name>' is used to identify the connection internally but
+       otherwise has no special meaning.
+       +
+       An instance block accepts the following configuration options:
+
+       *Socket* '<path>';;
+               The path name of the UNIX domain socket provided by the livestatus
+               module.
+
+SEE ALSO
+--------
+*sysdbd*(1), *sysdbd.conf*(5)
+
+AUTHOR
+------
+sysdbd was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
+
+COPYRIGHT
+---------
+Copyright (C) 2012-2014 Sebastian "tokkee" Harl <sh@tokkee.org>
+
+This is free software under the terms of the BSD license, see the source for
+copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.
+
+// vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :
+