From: Michael Friedrich Date: Wed, 27 Aug 2014 17:52:59 +0000 (+0200) Subject: Fix the documentation for manubulon check plugin commands X-Git-Tag: v2.1.0~10^2~1 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=b4953a613bbfdaa6652298904d6dacd2f7e7b09b;p=icinga2 Fix the documentation for manubulon check plugin commands refs #6650 --- diff --git a/doc/6-configuring-icinga-2.md b/doc/6-configuring-icinga-2.md index 3db60cd6c..6e5641862 100644 --- a/doc/6-configuring-icinga-2.md +++ b/doc/6-configuring-icinga-2.md @@ -2313,23 +2313,26 @@ The `running_kernel` check command does not support any vars. ### Overview -The SNMP Manubulon Plugin Check Commands provides example configuration for plugin check commands provided by the Snmp Manubulon plugins. +The `SNMP Manubulon Plugin Check Commands` provide example configuration for plugin check +commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html). -The SNMP manubulon plugin check commands assume that there's a global constant named `ManubulonPluginDir` which contains the path of the plugins from the Snmp Manubulon page. +The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir` +is set to the path where the Manubublon SNMP plugins are installed. -You can make usage this plugin by using the include directive in your configuration file: +You can enable these plugin check commands by adding the following the include directive in your +configuration [icinga2.conf](#icinga2-conf) file: include -### Checks you can make by host type +### Checks by Host Type -**N/A** : nothing of this type to check. +**N/A** : Not available for this type. -**SNMP** : yes with simple SNMP query. +**SNMP** : Available for simple SNMP query. -**??** : not tested because useless most of the time. +**??** : Untested. -**Specific** : name of the script to look at for platform specific checks. +**Specific** : Script name for platform specific checks. Host type | Interface | storage | load/cpu | mem | process | env | specific @@ -2351,7 +2354,7 @@ You can make usage this plugin by using the include directive in your configurat #### snmp-load -Check command object for the check_snmp_load.pl plugin. +Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin. Custom Attributes: @@ -2371,12 +2374,12 @@ snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default. snmp_warn | **Optional.** The warning threshold. snmp_crit | **Optional.** The critical threshold. -snmp_load_type | **Optional.** Load type. Default to "stand". Check all availables snmp load. +snmp_load_type | **Optional.** Load type. Defaults to "stand". Check all available types int the [snmp load](http://nagios.manubulon.com/snmp_load.html) documentation. snmp_perf | **Optional.** Enable perfdata values. Defaults to "true". #### snmp-memory -Check command object for the check_snmp_mem.pl plugin. +Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin. Custom Attributes: @@ -2399,7 +2402,7 @@ snmp_perf | **Optional.** Enable perfdata values. Defaults to "tru #### snmp-storage -Check command object for the check_snmp_storage.pl plugin. +Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin. Custom Attributes: @@ -2418,12 +2421,12 @@ snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.. snmp_warn | **Optional.** The warning threshold. snmp_crit | **Optional.** The critical threshold. -snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". Check more options in snmp storage. +snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation. snmp_perf | **Optional.** Enable perfdata values. Defaults to "true". #### snmp-int -Check command object for the check_snmp_int.pl plugin. +Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin. Custom Attributes: @@ -2450,7 +2453,7 @@ snmp_perf | **Optional.** Enable perfdata values. Defaults to "tru #### snmp-process -Check command object for the check_snmp_process.pl plugin. +Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin. Custom Attributes: diff --git a/etc/icinga2/constants.conf.cmake b/etc/icinga2/constants.conf.cmake index d2337226f..faf6067fe 100644 --- a/etc/icinga2/constants.conf.cmake +++ b/etc/icinga2/constants.conf.cmake @@ -7,7 +7,9 @@ const PluginDir = "@ICINGA2_PLUGINDIR@" -/* The directory which contains the Manubulon plugins from http://nagios.manubulon.com/index_snmp.html. */ +/* The directory which contains the Manubulon plugins. + * Check the documentation, chapter "SNMP Manubulon Plugin Check Commands", for details. + */ const ManubulonPluginDir = "@ICINGA2_PLUGINDIR@" /* Our local instance name. By default this is the server's hostname as returned by `hostname --fqdn`.