From: Michael Friedrich <michael.friedrich@netways.de>
Date: Mon, 17 Mar 2014 17:08:05 +0000 (+0100)
Subject: Documentation: Fix StateFilterOK for recovery notifications.
X-Git-Tag: v0.0.9~82
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=67782607ebd32f4ae5fe7d6569b92ddd4d3ce4e1;p=icinga2

Documentation: Fix StateFilterOK for recovery notifications.

Refs #5762
---

diff --git a/doc/3.04-notifications.md b/doc/3.04-notifications.md
index 01f81d730..6f1b09a1d 100644
--- a/doc/3.04-notifications.md
+++ b/doc/3.04-notifications.md
@@ -25,7 +25,8 @@ The user `icingaadmin` in the example below will get notified only on `WARNING`
     object User "icingaadmin" {
       display_name = "Icinga 2 Admin",
       enable_notifications = 1,
-      notification_state_filter = (StateFilterWarning |
+      notification_state_filter = (StateFilterOK |
+                                   StateFilterWarning |
                                    StateFilterCritical),
       notification_type_filter = (NotificationFilterProblem |
                                    NotificationFilterRecovery),  
@@ -40,6 +41,7 @@ The user `icingaadmin` in the example below will get notified only on `WARNING`
 > If you don't set the `notification_state_filter` and `notification_type_filter`
 > configuration attributes for the `User` object, all states and types will be
 > notified.
+> Recovery notifications require the state filter `StateFilterOK`.
 
 You should choose which information you (and your notified users) are interested in
 case of emergency, and also which information does not provide any value to you and
diff --git a/doc/4.3-object-types.md b/doc/4.3-object-types.md
index 281a31949..68847254e 100644
--- a/doc/4.3-object-types.md
+++ b/doc/4.3-object-types.md
@@ -252,7 +252,8 @@ Example:
       enable_notifications = 1,
       notification_period = "24x7",
 
-      notification_state_filter = (StateFilterWarning |
+      notification_state_filter = (StateFilterOK |
+                                   StateFilterWarning |
                                    StateFilterCritical |
                                    StateFilterUnknown),
       notification_type_filter = (NotificationFilterProblem |
@@ -274,7 +275,7 @@ Available notification type and state filters:
     StateFilterWarning
     StateFilterCritical
     StateFilterUnknown
-    
+
     NotificationFilterDowntimeStart
     NotificationFilterDowntimeEnd
     NotificationFilterDowntimeRemoved
@@ -284,10 +285,11 @@ Available notification type and state filters:
     NotificationFilterRecovery
     NotificationFilterFlappingStart
     NotificationFilterFlappingEnd
-    
+
 > **Note**
 >
 > In order to notify on problem states, you will need the type filter `NotificationFilterProblem`.
+> Recovery notifications require the state filter `StateFilterOK`.
 
 Attributes: