Docs: Add a note on required configuration updates for new notification scripts in v2.7.0

refs #5475
This commit is contained in:
Michael Friedrich 2017-08-08 12:10:29 +02:00
parent fafa84de73
commit fdaacf2d77
2 changed files with 48 additions and 1 deletions

View File

@ -4,7 +4,7 @@
### Notes ### Notes
* New mail notification scripts * New mail notification scripts. Please note that this requires a configuration update to NotificationCommand objects, Notification apply rules for specific settings and of course the notification scripts. More can be found [here](https://github.com/Icinga/icinga2/pull/5475).
* check_nscp_api plugin for NSClient++ REST API checks * check_nscp_api plugin for NSClient++ REST API checks
* Work queues for features including logs & metrics * Work queues for features including logs & metrics
* More metrics for the "icinga" check * More metrics for the "icinga" check

View File

@ -1581,6 +1581,53 @@ defaults can always be overwritten locally.
> This example requires the `mail` binary installed on the Icinga 2 > This example requires the `mail` binary installed on the Icinga 2
> master. > master.
#### Notification Commands in 2.7 <a id="notification-command-2-7"></a>
Icinga 2 v2.7.0 introduced new notification scripts which support both
environment variables and command line parameters.
Therefore the `NotificationCommand` objects inside the [commands.conf](04-configuring-icinga-2.md#commands-conf)
and `Notification` apply rules inside the [notifications.conf](04-configuring-icinga-2.md#notifications-conf)
configuration files have been updated. Your configuration needs to be
updated next to the notification scripts themselves.
> **Note**
>
> Several parameters have been changed. Please review the notification
> script parameters and configuration objects before updating your production
> environment.
The safest way is to incorporate the configuration updates from
v2.7.0 inside the [commands.conf](04-configuring-icinga-2.md#commands-conf) and [notifications.conf](04-configuring-icinga-2.md#notifications-conf)
configuration files.
A quick-fix is shown below:
@@ -5,7 +5,8 @@ object NotificationCommand "mail-host-notification" {
env = {
NOTIFICATIONTYPE = "$notification.type$"
- HOSTALIAS = "$host.display_name$"
+ HOSTNAME = "$host.name$"
+ HOSTDISPLAYNAME = "$host.display_name$"
HOSTADDRESS = "$address$"
HOSTSTATE = "$host.state$"
LONGDATETIME = "$icinga.long_date_time$"
@@ -22,8 +23,9 @@ object NotificationCommand "mail-service-notification" {
env = {
NOTIFICATIONTYPE = "$notification.type$"
- SERVICEDESC = "$service.name$"
- HOSTALIAS = "$host.display_name$"
+ SERVICENAME = "$service.name$"
+ HOSTNAME = "$host.name$"
+ HOSTDISPLAYNAME = "$host.display_name$"
HOSTADDRESS = "$address$"
SERVICESTATE = "$service.state$"
LONGDATETIME = "$icinga.long_date_time$"
```
#### mail-host-notification <a id="mail-host-notification"></a> #### mail-host-notification <a id="mail-host-notification"></a>
The `mail-host-notification` NotificationCommand object uses the The `mail-host-notification` NotificationCommand object uses the