Medientyp Objekt

Die folgenden Objekte stehen in direktem Zusammenhang mit der mediatype API.

Medientyp

Das Medientypobjekt verfügt über die folgenden Eigenschaften.

Property Type Beschreibung
mediatypeid ID ID des Medientyps.

Eigenschaftsverhalten:
- schreibgeschützt
- erforderlich für Aktualisierungsvorgänge
name string Name des Medientyps.

Eigenschaftsverhalten:
- erforderlich für Erstellungsvorgänge
type integer Vom Medientyp verwendetes Transportprotokoll.

Mögliche Werte:
0 - E-Mail;
1 - Skript;
2 - SMS;
4 - Webhook.

Eigenschaftsverhalten:
- erforderlich für Erstellungsvorgänge
exec_path string Name der Skriptdatei (z. B. notification.sh), die sich in dem Verzeichnis befindet, das im Server-Konfigurationsparameter AlertScriptsPath angegeben ist.

Eigenschaftsverhalten:
- erforderlich, wenn type auf „Script“ gesetzt ist
gsm_modem string Name des seriellen Geräts des GSM-Modems.

Eigenschaftsverhalten:
- erforderlich, wenn type auf „SMS“ gesetzt ist
passwd string Authentifizierungskennwort.

Eigenschaftsverhalten:
- unterstützt, wenn smtp_authentication auf „Normal password“ gesetzt ist
provider integer E-Mail-Anbieter.

Mögliche Werte:
0 - (Standard) Generisches SMTP;
1 - Gmail;
2 - Gmail relay;
3 - Office365;
4 - Office365 relay.
smtp_email string E-Mail-Adresse, von der Benachrichtigungen gesendet werden.

Eigenschaftsverhalten:
- erforderlich, wenn type auf „Email“ gesetzt ist
smtp_helo string SMTP-HELO.

Eigenschaftsverhalten:
- unterstützt, wenn type auf „Email“ gesetzt ist
smtp_server string SMTP-Server.

Eigenschaftsverhalten:
- erforderlich, wenn type auf „Email“ gesetzt ist
smtp_port integer Port des SMTP-Servers, zu dem eine Verbindung hergestellt werden soll.

Standard: 25.

Eigenschaftsverhalten:
- unterstützt, wenn type auf „Email“ gesetzt ist
smtp_security integer Zu verwendende Sicherheitsstufe der SMTP-Verbindung.

Mögliche Werte:
0 - (Standard) Keine;
1 - STARTTLS;
2 - SSL/TLS.

Eigenschaftsverhalten:
- unterstützt, wenn type auf „Email“ gesetzt ist
smtp_verify_host integer SSL-Überprüfung des Hosts für SMTP.

Mögliche Werte:
0 - (Standard) Nein;
1 - Ja.

Eigenschaftsverhalten:
- unterstützt, wenn smtp_security auf „STARTTLS“ oder „SSL/TLS“ gesetzt ist
smtp_verify_peer integer SSL-Überprüfung des Peers für SMTP.

Mögliche Werte:
0 - (Standard) Nein;
1 - Ja.

Eigenschaftsverhalten:
- unterstützt, wenn smtp_security auf „STARTTLS“ oder „SSL/TLS“ gesetzt ist
smtp_authentication integer Zu verwendende SMTP-Authentifizierungsmethode.

Mögliche Werte:
0 - (Standard) Keine;
1 - Normales Kennwort;
2 - OAuth-Token.
OAuth-Authentifizierung ist für den E-Mail-Anbieter Office365 relay nicht zulässig.

Eigenschaftsverhalten:
- unterstützt, wenn type auf „Email“ gesetzt ist
redirection_url string Zabbix-Frontend-URL, zu der die OAuth-Autorisierung zurückleitet.

Standard:
Wert der API-Einstellungseigenschaft url mit dem Teil zabbix.php?action=oauth.authorize

Eigenschaftsverhalten:
- erforderlich, wenn smtp_authentication auf „OAuth token“ gesetzt ist
client_id string Die beim OAuth-Autorisierungsserver registrierte Client-ID.

Eigenschaftsverhalten:
- erforderlich, wenn smtp_authentication auf „OAuth token“ gesetzt ist
client_secret string Das beim OAuth-Autorisierungsserver registrierte Clientgeheimnis. Nur für Benutzer des Typs Super Admin zugänglich.

Eigenschaftsverhalten:
- erforderlich, wenn smtp_authentication auf „OAuth token“ gesetzt ist
authorization_url string OAuth-URL mit Parametern zum Abrufen von Zugriffs- und Aktualisierungstoken.

Eigenschaftsverhalten:
- erforderlich, wenn smtp_authentication auf „OAuth token“ gesetzt ist
token_url string OAuth-URL zum Austauschen des Autorisierungstokens gegen Zugriffs- und Aktualisierungstoken.
Diese URL wird vom Server auch zum Aktualisieren eines ungültigen Zugriffstokens verwendet.

Eigenschaftsverhalten:
- erforderlich, wenn smtp_authentication auf „OAuth token“ gesetzt ist
tokens_status integer Bitmaske für den Status der Token.

Mögliche Werte:
0 - (Standard) Beide Token enthalten einen ungültigen Wert
1 - Das Zugriffstoken enthält einen gültigen Wert
2 - Das Aktualisierungstoken enthält einen gültigen Wert
3 - Beide Token enthalten einen gültigen Wert.

Eigenschaftsverhalten:
- unterstützt, wenn smtp_authentication auf „OAuth token“ gesetzt ist
access_token string Wert des OAuth-Zugriffstokens.

Eigenschaftsverhalten:
- erforderlich, wenn smtp_authentication auf „OAuth token“ gesetzt ist
access_token_updated timestamp Zeitstempel der letzten Änderung von access_token, die vom Server bei der Aktualisierung mit refresh_token oder von der API bei Tokenänderungen vorgenommen wurde.

Eigenschaftsverhalten:
- unterstützt, wenn smtp_authentication auf „OAuth token“ gesetzt ist
access_expires_in integer Zeit in Sekunden, nach der access_token veraltet ist und eine Anfrage an refresh_url erforderlich wird.
Wird vom Zabbix-Server bei der Aktualisierung von access_token oder von der API bei Tokenänderungen gesetzt.

Der Zeitstempel wird durch Addition des Werts von access_token_updated berechnet.

Eigenschaftsverhalten:
- unterstützt, wenn smtp_authentication auf „OAuth token“ gesetzt ist
refresh_token string Wert des OAuth-Aktualisierungstokens.

Eigenschaftsverhalten:
- erforderlich, wenn smtp_authentication auf „OAuth token“ gesetzt ist
status integer Gibt an, ob der Medientyp aktiviert ist.

Mögliche Werte:
0 - (Standard) Aktiviert;
1 - Deaktiviert.
username string Benutzername.

Eigenschaftsverhalten:
- unterstützt, wenn smtp_authentication auf „Normal password“ gesetzt ist
maxsessions integer Maximale Anzahl von Benachrichtigungen, die parallel verarbeitet werden können.

Möglicher Wert, wenn type auf „SMS“ gesetzt ist: 1.

Mögliche Werte, wenn type auf „Email“, „Script“ oder „Webhook“ gesetzt ist: 0-100.

Standard: 1.
maxattempts integer Maximale Anzahl der Versuche zum Senden einer Benachrichtigung.

Mögliche Werte: 1-100.

Standard: 3.
attempt_interval string Intervall zwischen Wiederholungsversuchen.
Akzeptiert eine Anzahl von Sekunden (z. B. 1, 30, 60) oder einen Wert mit einem Zeitsuffix (z. B. 30s, 1m, 1h).

Mögliche Werte: 0-1h.

Standard: 10s.
message_format integer Nachrichtenformat.

Mögliche Werte:
0 - Nur Text;
1 - (Standard) HTML.

Eigenschaftsverhalten:
- unterstützt, wenn type auf „Email“ gesetzt ist
script text Text des Webhook-Skripts (JavaScript).

Eigenschaftsverhalten:
- erforderlich, wenn type auf „Webhook“ gesetzt ist
timeout string Zeitüberschreitung des Webhook-Skripts.
Akzeptiert eine Anzahl von Sekunden (z. B. 1, 60) oder einen Wert mit einem Zeitsuffix (z. B. 30s, 1m).

Mögliche Werte: 1-60s.

Standard: 30s.

Eigenschaftsverhalten:
- unterstützt, wenn type auf „Webhook“ gesetzt ist
process_tags integer Verarbeitet JSON-Eigenschaftswerte in der Antwort des Webhook-Skripts als Tags. Diese Tags werden zu allen vorhandenen Problem-Tags hinzugefügt.

Mögliche Werte:
0 - (Standard) Antwort des Webhook-Skripts ignorieren;
1 - Antwort des Webhook-Skripts als Tags verarbeiten.

Eigenschaftsverhalten:
- unterstützt, wenn type auf „Webhook“ gesetzt ist
show_event_menu integer Fügt einen Eintrag im Ereignismenü hinzu, der auf eine benutzerdefinierte URL verweist. Fügt außerdem die Eigenschaft urls zur Ausgabe von problem.get und event.get hinzu.

Mögliche Werte:
0 - (Standard) Keinen Ereignismenüeintrag und keine Eigenschaft urls einschließen;
1 - Ereignismenüeintrag und Eigenschaft urls einschließen.

Eigenschaftsverhalten:
- unterstützt, wenn type auf „Webhook“ gesetzt ist
event_menu_url string URL, die im Eintrag des Ereignismenüs und in der von problem.get und event.get zurückgegebenen Eigenschaft urls verwendet wird.

Eigenschaftsverhalten:
- unterstützt, wenn show_event_menu auf „Include event menu entry and urls property“ gesetzt ist
event_menu_name string Name, der für den Eintrag des Ereignismenüs und in der von problem.get und event.get zurückgegebenen Eigenschaft urls verwendet wird.

Eigenschaftsverhalten:
- unterstützt, wenn show_event_menu auf „Include event menu entry and urls property“ gesetzt ist
parameters array Parameter für Webhook oder Skript.

Eigenschaftsverhalten:
- unterstützt, wenn type auf „Webhook“ oder „Script“ gesetzt ist
description text Beschreibung des Medientyps.

webhook-Parameter

webhook-Parameter haben die folgenden Eigenschaften.

Eigenschaft Type Beschreibung
name string Parametername.

Eigenschaftsverhalten:
- erforderlich
value string Parameterwert, unterstützt Makros.
Unterstützte Makros sind auf der Seite Unterstützte Makros beschrieben.

Skriptparameter

Skriptparameter haben die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
sortorder integer Die Reihenfolge, in der Parameterwerte als Befehlszeilenargumente an das Skript übergeben werden, beginnend mit 0 als erstem Wert.

Verhalten der Eigenschaft:
- erforderlich
value string Parameterwert, unterstützt Makros.
Unterstützte Makros werden auf der Seite Unterstützte Makros beschrieben.

Nachrichtenvorlage

Das Nachrichtenvorlagenobjekt definiert eine Vorlage, die als Standardnachricht für Aktionsoperationen zum Senden einer Benachrichtigung verwendet wird. Es hat die folgenden Eigenschaften.

Eigenschaft Type Beschreibung
eventsource integer Ereignisquelle.

Mögliche Werte:
0 - Auslöser;
1 - Discovery;
2 - Autoregistrierung;
3 - Intern;
4 - Services.

Verhalten der Eigenschaft:
- erforderlich
recovery integer Operationsmodus.

Mögliche Werte:
0 - Operationen;
1 - Wiederherstellungsoperationen;
2 - Aktualisierungsoperationen.

Verhalten der Eigenschaft:
- erforderlich
subject string Betreff der Nachricht.
message string Nachrichtentext.