From: Nicole Lang <nicole.lang@netways.de>
Date: Fri, 30 Sep 2016 09:41:32 +0000 (+0200)
Subject: Docs: Add more Timeperiod examples
X-Git-Tag: v2.6.0~95
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=00b27d316a51ba8bed187613c927ecf01bad7759;p=icinga2

Docs: Add more Timeperiod examples

fixes #12834

Signed-off-by: Michael Friedrich <michael.friedrich@netways.de>
---

diff --git a/doc/8-advanced-topics.md b/doc/8-advanced-topics.md
index 45d1b4e8c..a123da3a5 100644
--- a/doc/8-advanced-topics.md
+++ b/doc/8-advanced-topics.md
@@ -196,8 +196,36 @@ create a new timeperiod named `workhours` defining a work day from
       }
     }
 
-Use the `period` attribute to assign time periods to
-`Notification` and `Dependency` objects:
+Furthermore if you wish to specify a notification period across midnight,
+you can define it the following way:
+
+    object Timeperiod "across-midnight" {
+      import "legacy-timeperiod"
+
+      display_name = "Nightly Notification"
+      ranges = {
+        "saturday" = "22:00-24:00"
+        "sunday" = "00:00-03:00"
+      }
+    }
+
+Below you can see another example for configuring timeperiods across several
+days, weeks or months. This can be useful when taking components offline
+for a distinct period of time.
+
+    object Timeperiod "standby" {
+      import "legacy-timeperiod"
+
+      display_name = "Standby"
+      ranges = {
+        "2016-09-30 - 2016-10-30" = "00:00-24:00"
+      }
+    }
+
+Please note that the spaces before and after the dash are mandatory.
+
+Once your time period is configured you can Use the `period` attribute
+to assign time periods to `Notification` and `Dependency` objects:
 
     object Notification "mail" {
       import "generic-notification"