Skript-Objekt

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

Skript

Das Skriptobjekt hat die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
scriptid ID ID des Skripts.

Verhalten der Eigenschaft:
- schreibgeschützt
- erforderlich für Aktualisierungsvorgänge
name string Name des Skripts.

Verhalten der Eigenschaft:
- erforderlich für Erstellungsvorgänge
type integer Skripttyp.

Mögliche Werte, wenn scope auf „action operation“ gesetzt ist:
0 - Skript;
1 - IPMI;
2 - SSH;
3 - TELNET;
5 - Webhook.

Mögliche Werte, wenn scope auf „manual host action“ oder „manual event action“ gesetzt ist:
6 - URL.

Verhalten der Eigenschaft:
- erforderlich für Erstellungsvorgänge
command string Auszuführender Befehl.

Verhalten der Eigenschaft:
- erforderlich, wenn type auf „Skript“, „IPMI“, „SSH“, „TELNET“ oder „Webhook“ gesetzt ist
scope integer Geltungsbereich des Skripts.

Mögliche Werte:
1 - action operation;
2 - manual host action;
4 - manual event action.

Verhalten der Eigenschaft:
- erforderlich für Erstellungsvorgänge
execute_on integer Wo das Skript ausgeführt werden soll.

Mögliche Werte:
0 - auf Zabbix Agent ausführen;
1 - auf Zabbix Server ausführen. Dies wird nur unterstützt, wenn die Ausführung globaler Skripte auf dem Zabbix Server aktiviert ist;
2 - (Standard) auf Zabbix Server oder Proxy ausführen.

Verhalten der Eigenschaft:
- unterstützt, wenn type auf „Skript“ gesetzt ist
menu_path string Durch Schrägstriche getrennte Ordner, die beim Klicken auf einen Host oder ein Ereignis eine menüartige Navigation im Frontend bilden.

Verhalten der Eigenschaft:
- unterstützt, wenn scope auf „manual host action“ oder „manual event action“ gesetzt ist
authtype integer Für den SSH-Skripttyp verwendete Authentifizierungsmethode.

Mögliche Werte:
0 - Passwort;
1 - öffentlicher Schlüssel.

Verhalten der Eigenschaft:
- unterstützt, wenn type auf „SSH“ gesetzt ist
username string Für die Authentifizierung verwendeter Benutzername.

Verhalten der Eigenschaft:
- erforderlich, wenn type auf „SSH“ oder „TELNET“ gesetzt ist
password string Passwort für SSH-Skripte mit Passwortauthentifizierung und TELNET-Skripte.

Verhalten der Eigenschaft:
- unterstützt, wenn type auf „SSH“ und authtype auf „password“ gesetzt ist oder type auf „TELNET“ gesetzt ist
publickey string Name der Datei mit dem öffentlichen Schlüssel für SSH-Skripte mit Authentifizierung per öffentlichem Schlüssel.

Verhalten der Eigenschaft:
- erforderlich, wenn type auf „SSH“ und authtype auf „public key“ gesetzt ist
privatekey string Name der Datei mit dem privaten Schlüssel für SSH-Skripte mit Authentifizierung per öffentlichem Schlüssel.

Verhalten der Eigenschaft:
- erforderlich, wenn type auf „SSH“ und authtype auf „public key“ gesetzt ist
port string Portnummer für SSH- und TELNET-Skripte.

Verhalten der Eigenschaft:
- unterstützt, wenn type auf „SSH“ oder „TELNET“ gesetzt ist
groupid ID ID der Hostgruppe, auf der das Skript ausgeführt werden kann.

Wenn auf „0“ gesetzt, ist das Skript in allen Hostgruppen verfügbar.

Standard: 0.
usrgrpid ID ID der Benutzergruppe, die das Skript ausführen darf.

Wenn auf „0“ gesetzt, ist das Skript für alle Benutzergruppen verfügbar.

Standard: 0.

Verhalten der Eigenschaft:
- unterstützt, wenn scope auf „manual host action“ oder „manual event action“ gesetzt ist
host_access integer Zum Ausführen des Skripts erforderliche Host-Berechtigungen.

Mögliche Werte:
2 - (Standard) Lesen;
3 - Schreiben.

Verhalten der Eigenschaft:
- unterstützt, wenn scope auf „manual host action“ oder „manual event action“ gesetzt ist
confirmation string Text des Bestätigungs-Pop-ups.
Das Pop-up wird angezeigt, wenn versucht wird, das Skript aus dem Zabbix Frontend auszuführen.

Verhalten der Eigenschaft:
- unterstützt, wenn scope auf „manual host action“ oder „manual event action“ gesetzt ist
timeout string Zeitüberschreitung für die Ausführung des webhook-Skripts in Sekunden. Zeitsuffixe werden unterstützt (z. B. 30s, 1m).

Mögliche Werte: 1-60s.

Standard: 30s.

Verhalten der Eigenschaft:
- erforderlich, wenn type auf „Webhook“ gesetzt ist
parameters array Array von webhook-Eingabeparametern.

Verhalten der Eigenschaft:
- unterstützt, wenn type auf „Webhook“ gesetzt ist
description string Beschreibung des Skripts.
url string Benutzerdefinierte URL.

Verhalten der Eigenschaft:
- erforderlich, wenn type auf „URL“ gesetzt ist
new_window integer URL in einem neuen Fenster öffnen.

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

Verhalten der Eigenschaft:
- unterstützt, wenn type auf „URL“ gesetzt ist
manualinput integer Gibt an, ob das Skript benutzerseitig bereitgestellte Eingaben akzeptiert.

Mögliche Werte:
0 - (Standard) Deaktiviert;
1 - Aktiviert;

Verhalten der Eigenschaft:
- unterstützt, wenn scope auf „manual host action“ oder „manual event action“ gesetzt ist
manualinput_prompt string Text der Aufforderung für die manuelle Eingabe.

Verhalten der Eigenschaft:
- erforderlich, wenn manualinput auf „Enabled“ gesetzt ist
manualinput_validator string Ein Zeichenkettenfeld zur Validierung der vom Benutzer bereitgestellten Eingabe. Die Zeichenkette besteht entweder aus einem regulären Ausdruck oder aus einer durch Kommas getrennten Menge von Werten.

Verhalten der Eigenschaft:
- erforderlich, wenn manualinput auf „Enabled“ gesetzt ist
manualinput_validator_type integer Bestimmt den erwarteten Typ der Benutzereingabe.

Mögliche Werte:
0 - (Standard) Zeichenkette. Gibt an, dass manualinput_validator als regulärer Ausdruck behandelt werden soll;
1 - Liste. Gibt an, dass manualinput_validator als durch Kommas getrennte Liste möglicher Eingabewerte behandelt werden soll.

Verhalten der Eigenschaft:
- unterstützt, wenn manualinput auf „Enabled“ gesetzt ist
manualinput_default_value string Standardwert zum automatischen Ausfüllen der Benutzereingabe.

Verhalten der Eigenschaft:
- unterstützt, wenn manualinput_validator_type auf „String“ gesetzt ist

webhook-Parameter

Parameter, die beim Aufruf an das webhook-Skript übergeben werden, haben die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
name string Parametername.

Verhalten der Eigenschaft:
- erforderlich
value string Parameterwert. Unterstützt Makros.

Debug

Debug-Informationen des ausgeführten webhook-Skripts. Das Debug-Objekt hat die folgenden Eigenschaften.

Eigenschaft Type Beschreibung
logs array Array von Log-Einträgen.
ms string Dauer der Skriptausführung in Millisekunden.

Protokolleintrag

Das Protokolleintrag-Objekt hat die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
level integer Protokollebene.
ms string Die in Millisekunden verstrichene Zeit seit der Ausführung des Skripts, bevor der Protokolleintrag hinzugefügt wurde.
message string Protokollnachricht.