notifications: describe new notification metadata fields

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Reviewed-by: Max Carrara <m.carrara@proxmox.com>
This commit is contained in:
Lukas Wagner 2024-07-08 11:38:10 +02:00 committed by Thomas Lamprecht
parent 456b17fa59
commit 3b55c73fc2

View File

@ -304,9 +304,10 @@ Notification Events
| Event | `type` | Severity | Metadata fields (in addition to `type`)
| System updates available |`package-updates` | `info` | `hostname`
| Cluster node fenced |`fencing` | `error` | `hostname`
| Storage replication failed |`replication` | `error` | -
| Backup finished |`vzdump` | `info` (`error` on failure) | `hostname`
| Mail for root |`system-mail` | `unknown`| -
| Storage replication job failed |`replication` | `error` | `hostname`, `job-id`
| Backup succeeded |`vzdump` | `info` | `hostname`, `job-id` (only for backup jobs)
| Backup failed |`vzdump` | `error` | `hostname`, `job-id` (only for backup jobs)
| Mail for root |`system-mail` | `unknown`| `hostname`
|===========================================================================
[width="100%",options="header"]
@ -314,6 +315,7 @@ Notification Events
| Field name | Description
| `type` | Type of the notification
| `hostname` | Hostname, without domain (e.g. `pve1`)
| `job-id` | Job ID
|=======================================================================
System Mail Forwarding