]> granicus.if.org Git - icinga2/commitdiff
Docs: Add event::SuppressedNotifications to technical concepts
authorMichael Friedrich <michael.friedrich@icinga.com>
Thu, 11 Jul 2019 08:43:31 +0000 (10:43 +0200)
committerMichael Friedrich <michael.friedrich@icinga.com>
Thu, 11 Jul 2019 08:44:57 +0000 (10:44 +0200)
doc/19-technical-concepts.md

index 12ed44f4b4e7b66b2b5118e9619ae75f7fe70e22..187d3a5c4895f4baaf5935683981b473d9063009 100644 (file)
@@ -1278,6 +1278,41 @@ Message updates will be dropped when:
 * Checkable does not exist.
 * Origin endpoint's zone is not allowed to access this checkable.
 
+#### event::SuppressedNotifications <a id="technical-concepts-json-rpc-messages-event-setsupressednotifications"></a>
+
+> Location: `clusterevents.cpp`
+
+##### Message Body
+
+Key       | Value
+----------|---------
+jsonrpc   | 2.0
+method    | event::SuppressedNotifications
+params    | Dictionary
+
+##### Params
+
+Key                     | Type          | Description
+-------------------------|---------------|------------------
+host                    | String        | Host name
+service                 | String        | Service name
+supressed\_notifications | Number       | Bitmask for suppressed notifications.
+
+##### Functions
+
+Event Sender: `Checkable::OnSuppressedNotificationsChanged`
+Event Receiver: `SuppressedNotificationsChangedAPIHandler`
+
+##### Permissions
+
+The receiver will not process messages from not configured endpoints.
+
+Message updates will be dropped when:
+
+* Checkable does not exist.
+* Origin endpoint's zone is not allowed to access this checkable.
+
+
 #### event::SetNextNotification <a id="technical-concepts-json-rpc-messages-event-setnextnotification"></a>
 
 > Location: `clusterevents.cpp`