]> granicus.if.org Git - icinga2/commitdiff
Refined documentation for the "update-windows" check plugin
authorHannes Happle <info@h2-it.de>
Tue, 25 Apr 2017 15:26:39 +0000 (17:26 +0200)
committerHannes Happle <info@h2-it.de>
Tue, 25 Apr 2017 15:43:12 +0000 (17:43 +0200)
Marked optional custom attributes as optional
Added information on the behavior of the plugin regarding the custom attributes being booleans instead of -as usual- setting thresholds

refs #5178

doc/10-icinga-template-library.md

index 7b0e7c86595722c992d8f2ac292827318adb7cb0..4ee7ca74d0b061c8c216360f24573542fd3113c7 100644 (file)
@@ -1593,9 +1593,16 @@ Custom attributes:
 
 Name                | Description
 :-------------------|:------------
-update\_win\_warn   | If set, returns warning when important updates are available
-update\_win\_crit   | If set, return critical when important updates that require a reboot are available.
-update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
+update\_win\_warn   | **Optional**. If set, returns warning when important updates are available.
+update\_win\_crit   | **Optional**. If set, return critical when important updates that require a reboot are available.
+update\_win\_reboot | **Optional**. Set to treat 'may need update' as 'definitely needs update'. Please Note that this is true for almost every update and is therefore not recommended.
+
+
+In contrast to most other plugins, the values of check_update's custom attributes do not set thresholds, but just enable/disable the behaviour described in the table above.  
+It can be enabled/disabled for example by setting them to "true" or "false", "1" or "0" would also work.  
+Thresholds will always be "1".  
+**Hint**: If they are enabled, performance data will be shown in the webinterface.  
+If run without the optional parameters, the plugin will output critical if any important updates are available.  
 
 
 ### <a id="windows-plugins-uptime-windows"></a> uptime-windows