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 Aktualisierungsoperationen
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 im 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.

Property behavior:
- unterstützt, wenn type auf "Email" gesetzt ist
status integer Gibt an, 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, einen Alarm zu senden.

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.
content_type
(deprecated)		 integer Dieser Parameter ist veraltet, bitte verwenden Sie stattdessen message_format.
Nachrichtenformat.

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

Property behavior:
- unterstützt, wenn type auf "Email" gesetzt ist
message_format integer Nachrichtenformat.

Mögliche Werte:
0 - Reiner 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 des webhook-Skripts.
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ü und keine Eigenschaft urls einfügen;
1 - Eintrag im Ereignismenü und Eigenschaft urls einfügen.

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

Property behavior:
- unterstützt, wenn show_event_menu auf "Eintrag im Ereignismenü und Eigenschaft urls einfügen" gesetzt ist
event_menu_name string Name, der für den Eintrag im Ereignismenü und in der von problem.get und event.get zurückgegebenen Eigenschaft urls verwendet wird.

Property behavior:
- unterstützt, wenn show_event_menu auf "Eintrag im Ereignismenü und Eigenschaft urls einfügen" 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.