]> granicus.if.org Git - icinga2/commitdiff
Update documentation.
authorGunnar Beutner <gunnar@beutner.name>
Sat, 5 Apr 2014 20:32:52 +0000 (22:32 +0200)
committerGunnar Beutner <gunnar@beutner.name>
Sat, 5 Apr 2014 20:32:52 +0000 (22:32 +0200)
Refs #5925

doc/3.04-notifications.md
doc/3.06-groups.md
doc/3.07-time-periods.md
doc/3.12-status-data.md
doc/3.15-monitoring-remote-clients.md
doc/4.1-configuration-syntax.md

index 56e0bae7e08e75bbf99adfe9222f7f555ea912fe..9b94eeefedfbc6f7119bffcff57c7c39d86b89b8 100644 (file)
@@ -121,7 +121,7 @@ Use the `apply` keyword to create `Notification` objects for your services:
       notification_command = "mail-notification"
       users = [ "icingaadmin" ]
 
-      assign where service.name == "ping4"
+      assign where service.name == "mysql"
     }
     
 > **Note**
@@ -154,14 +154,14 @@ notifications between start and end time.
       display_name = "Icinga 2nd Level"
       enable_notifications = true
 
-      vars.mobile = "+49123456781"
+      vars.mobile = "+1 555 424642"
     }
     
     object User "icinga-oncall-1st-level" {
       display_name = "Icinga 1st Level"
       enable_notifications = true
 
-      vars.mobile = "+49123456782"
+      vars.mobile = "+1 555 424642"
       }
     }
     
index cdf3ed074e52f6d36861eb7904606e54095d8de5..149331c2151e5dc75fdcab8aa0b2212c25815a32 100644 (file)
@@ -52,7 +52,7 @@ the user groups are associated as attributes in `Notification` objects.
     }
     
     template User "generic-windows-mssql-users" {
-      groups = [ "windows-mssql-admins" ]
+      groups += [ "windows-mssql-admins" ]
     }
     
     object User "win-mssql-noc" {
@@ -66,9 +66,3 @@ the user groups are associated as attributes in `Notification` objects.
 
       vars.email = "ops@example.com"
     }
-
-    apply Service "ping4" {
-      import "generic-notification"
-      notification_command = "mail-notification"
-      user_groups = [ "windows-admins" ]
-    }
index e7ce3348504b0eaee380e2c2475de73537a45778..7c8b8e233e0d684f7e587fd65d6fbb7aa2e2a869 100644 (file)
@@ -66,12 +66,12 @@ create a new timeperiod named `workhours` defining a work day with
 Use the `notification_period` attribute to assign time periods to
 `Notification` objects:
 
-    apply Notification "mail" to Host {
+    object Notification "mail" {
       import "generic-notification"
 
+      host_name = "localhost"
+
       notification_command = "mail-notification"
       users = [ "icingaadmin" ]
       notification_period = "workhours"
-      
-      assign where host.name == "localhost"
     }
index 50fd5a05dd720c6fd17985bb546afefba3cec714..3051504ffdd983d7a8c52eb663051a2eebbb4c57 100644 (file)
@@ -11,8 +11,8 @@ Icinga 1.x Classic UI requires this data set as part of its backend.
 
 > **Note**
 >
-> If you are not using any web interface or addon requiring this output
-> do not enable this feature.
+> If you are not using any web interface or addon which uses these files
+> you can safely disable this feature.
 
 > **Note**
 >
index 08542d7d9365682f08d986f98582d78429365a2a..08a6fa1f18deb7ea1a866596f8486ebb6ec7cc05 100644 (file)
@@ -50,15 +50,16 @@ its return code and output. `check_by_ssh` is available in the [Monitoring Plugi
                 ]
     }
 
-    apply Service "swap" {
+    object Service "swap" {
       import "generic-service"
+
+      host_name = "remote-ssh-host"
+
       check_command = "check_by_ssh_swap"
       vars = {
             "warn" = "50%"
             "crit" = "75%"
       }
-      
-      assign where host.name == "remote-ssh-host"
     }
 
 #### NRPE
@@ -85,13 +86,13 @@ Example:
       ]
     }
 
-    apply Service "users" {
+    object Service "users" {
       import "generic-service"
   
+      host_name = "remote-nrpe-host"
+
       check_command = "check_nrpe"
       vars.remote_nrpe_command = "check_users"
-
-      assign where host.name == "remote-nrpe-host"
     }
 
 nrpe.cfg:
@@ -132,9 +133,11 @@ Example:
       }
     }
 
-    apply Service "users" {
+    object Service "users" {
       import "generic-service"
   
+      host_name = "remote-windows-host"
+
       check_command = "check_nscp"
 
       vars += {
@@ -143,8 +146,6 @@ Example:
         warn = "70"
         crit = "80"
       }
-
-      assign where host.name == "remote-windows-host"
     }
 
 For details on the `NSClient++` configuration please refer to the [official documentation](http://www.nsclient.org/nscp/wiki/doc/configuration/0.4.x).
@@ -153,7 +154,6 @@ For details on the `NSClient++` configuration please refer to the [official docu
 > 
 > The format of the `NSClient++` configuration file has changed from 0.3.x to 0.4!
 
-
 #### Icinga 2 Agent
 
 A dedicated Icinga 2 agent supporting all platforms and using the native
@@ -179,7 +179,6 @@ feature.
 
 The [Icinga 2 Vagrant Demo VM](#vagrant) ships a demo integration and further samples.
 
-
 #### SNMP Traps
 
 SNMP Traps can be received and filtered by using [SNMPTT](http://snmptt.sourceforge.net/) and specific trap handlers
index d2d8b3ffbeb964eb94e504ca034b8cf211ff71ee..201ea1372bc31d561cd2be6728ee6960426bc038 100644 (file)
@@ -34,8 +34,12 @@ The semi-colon after the last element (i.e. `address6`) may be omitted.
 > Exclamation marks (!) are not permitted in object names.
 
 Each object is uniquely identified by its type (`Host`) and name
-(`host1.example.org`). Objects can contain a comma-separated list of
-property declarations. Instead of commas semi-colons may also be used.
+(`host1.example.org`). Some types have composite names, e.g. the
+`Service` type which uses the hostname and the name you specified
+to generate its object name.
+
+Objects can contain a comma-separated list of property
+declarations. Instead of commas semi-colons may also be used.
 The following data types are available for property values:
 
 ### Expressions