Medientyp Objekt

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

Medientyp

Das Objekt Medientyp hat die folgenden Eigenschaften.

Property Type Description
mediatypeid ID ID des Medientyps.

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

Property behavior:
- erforderlich für Erstellungsoperationen
type integer Vom Medientyp verwendeter Transport.

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

Property behavior:
- erforderlich für Erstellungsoperationen
exec_path string Name der Skriptdatei (z. B. notification.sh), die sich in dem Verzeichnis befindet, das durch den Serverkonfigurationsparameter AlertScriptsPath angegeben ist.

Property behavior:
- erforderlich wenn type auf "Script" gesetzt ist
gsm_modem string Name des seriellen Geräts des GSM-Modems.

Property behavior:
- erforderlich wenn type auf "SMS" gesetzt ist
passwd string Authentifizierungskennwort.

Property behavior:
- 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.

Property behavior:
- erforderlich wenn type auf "Email" gesetzt ist
smtp_helo string SMTP HELO.

Property behavior:
- unterstützt wenn type auf "Email" gesetzt ist
smtp_server string SMTP-Server.

Property behavior:
- erforderlich wenn type auf "Email" gesetzt ist
smtp_port integer Port des SMTP-Servers, zu dem eine Verbindung hergestellt wird.

Standard: 25.

Property behavior:
- 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.

Property behavior:
- unterstützt wenn type auf "Email" gesetzt ist
smtp_verify_host integer SSL-Hostprüfung für SMTP.

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

Property behavior:
- unterstützt wenn smtp_security auf "STARTTLS" oder "SSL/TLS" gesetzt ist
smtp_verify_peer integer SSL-Peerprüfung für SMTP.

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

Property behavior:
- 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 Passwort;
2 - OAuth-Token.
OAuth-Authentifizierung ist für den E-Mail-Anbieter Office365 relay nicht zulässig.

Property behavior:
- unterstützt wenn type auf "Email" gesetzt ist
redirection_url string Zabbix Frontend-URL für die Rückleitung der OAuth-Autorisierung.

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

Property behavior:
- erforderlich wenn smtp_authentication auf "OAuth token" gesetzt ist
client_id string Die im OAuth-Autorisierungsserver registrierte Client-ID.

Property behavior:
- erforderlich wenn smtp_authentication auf "OAuth token" gesetzt ist
client_secret string Das im OAuth-Autorisierungsserver registrierte Client-Geheimnis. Nur für Benutzer vom Typ Super Admin zugänglich.

Property behavior:
- erforderlich wenn smtp_authentication auf "OAuth token" gesetzt ist
authorization_url string OAuth-URL mit Parametern zum Abrufen von Zugriffs- und Aktualisierungstokens.

Property behavior:
- erforderlich wenn smtp_authentication auf "OAuth token" gesetzt ist
token_url string OAuth-URL zum Austauschen des Autorisierungstokens gegen Zugriffs- und Aktualisierungstokens.
Diese URL wird auch vom Server verwendet, um ein ungültiges Zugriffstoken zu aktualisieren.

Property behavior:
- erforderlich wenn smtp_authentication auf "OAuth token" gesetzt ist
tokens_status integer Bitmaske für den Status der Tokens.

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

Property behavior:
- unterstützt wenn smtp_authentication auf "OAuth token" gesetzt ist
access_token string Wert des OAuth-Zugriffstokens.

Property behavior:
- erforderlich wenn smtp_authentication auf "OAuth token" gesetzt ist
access_token_updated timestamp Zeitstempel der letzten Änderung von access_token durch den Server beim Aktualisieren mit refresh_token oder durch die API bei Tokenänderungen.

Property behavior:
- unterstützt wenn smtp_authentication auf "OAuth token" gesetzt ist
access_expires_in integer Zeit in Sekunden, nach der access_token veraltet 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.

Property behavior:
- unterstützt wenn smtp_authentication auf "OAuth token" gesetzt ist
refresh_token string Wert des OAuth-Aktualisierungstokens.

Property behavior:
- erforderlich wenn smtp_authentication auf "OAuth token" gesetzt ist
status integer Ob der Medientyp aktiviert ist.

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

Property behavior:
- unterstützt wenn smtp_authentication auf "Normal password" gesetzt ist
maxsessions integer Die maximale Anzahl von Alarmen, die parallel verarbeitet werden können.

Mögliche Werte, 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 Die maximale Anzahl von Versuchen zum Senden eines Alarms.

Mögliche Werte: 1-100.

Standard: 3.
attempt_interval string Das Intervall zwischen Wiederholungsversuchen.
Akzeptiert Sekunden und Zeiteinheiten mit Suffix.

Mögliche Werte: 0-1h.

Standard: 10s.
message_format integer Nachrichtenformat.

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

Property behavior:
- unterstützt wenn type auf "Email" gesetzt ist
script text Webhook-Skripttext (JavaScript).

Property behavior:
- erforderlich wenn type auf "Webhook" gesetzt ist
timeout string Zeitüberschreitung für das webhook-Skript.
Akzeptiert Sekunden und Zeiteinheiten mit Suffix.

Mögliche Werte: 1-60s.

Standard: 30s.

Property behavior:
- 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.

Property behavior:
- 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 Eintrag im Ereignismenü oder die Eigenschaft urls einfügen;
1 - Eintrag im Ereignismenü und die Eigenschaft urls einfügen.

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

Property behavior:
- 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 im Ereignismenü und in der Eigenschaft urls verwendet wird, die von problem.get und event.get zurückgegeben wird.

Property behavior:
- unterstützt wenn show_event_menu auf "Include event menu entry and urls property" gesetzt ist
parameters array Parameter für Webhook oder Skript.

Property behavior:
- 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.