Obiekt skryptu

Następujące obiekty są bezpośrednio powiązane z API script.

Skrypt

Obiekt skryptu ma następujące właściwości.

Właściwość Typ Opis
scriptid ID ID skryptu.

Zachowanie właściwości:
- tylko do odczytu
- wymagane dla operacji aktualizacji
name string Nazwa skryptu.

Zachowanie właściwości:
- wymagane dla operacji tworzenia
type integer Typ skryptu.

Możliwe wartości, jeśli scope jest ustawione na "action operation":
0 - Script;
1 - IPMI;
2 - SSH;
3 - TELNET;
5 - Webhook.

Możliwe wartości, jeśli scope jest ustawione na "manual host action" lub "manual event action":
6 - URL.

Zachowanie właściwości:
- wymagane dla operacji tworzenia
command string Polecenie do uruchomienia.

Zachowanie właściwości:
- wymagane, jeśli type jest ustawione na "Script", "IPMI", "SSH", "TELNET" lub "Webhook"
scope integer Zakres skryptu.

Możliwe wartości:
1 - action operation;
2 - manual host action;
4 - manual event action.

Zachowanie właściwości:
- wymagane dla operacji tworzenia
execute_on integer Gdzie uruchomić skrypt.

Możliwe wartości:
0 - uruchom na Zabbix agent;
1 - uruchom na Zabbix serwer. Jest to obsługiwane tylko wtedy, gdy wykonywanie skryptów globalnych jest włączone na Zabbix serwerze;
2 - (domyślnie) uruchom na Zabbix serwerze lub proxy.

Zachowanie właściwości:
- obsługiwane, jeśli type jest ustawione na "Script"
menu_path string Foldery oddzielone ukośnikiem, które tworzą nawigację w formie menu w frontend po kliknięciu hosta lub zdarzenia.

Zachowanie właściwości:
- obsługiwane, jeśli scope jest ustawione na "manual host action" lub "manual event action"
authtype integer Metoda uwierzytelniania używana dla skryptu typu SSH.

Możliwe wartości:
0 - hasło;
1 - klucz publiczny.

Zachowanie właściwości:
- obsługiwane, jeśli type jest ustawione na "SSH"
username string Nazwa użytkownika używana do uwierzytelniania.

Zachowanie właściwości:
- wymagane, jeśli type jest ustawione na "SSH" lub "TELNET"
password string Hasło używane dla skryptów SSH z uwierzytelnianiem hasłem oraz skryptów TELNET.

Zachowanie właściwości:
- obsługiwane, jeśli type jest ustawione na "SSH" i authtype jest ustawione na "password", lub type jest ustawione na "TELNET"
publickey string Nazwa pliku klucza publicznego używanego dla skryptów SSH z uwierzytelnianiem kluczem publicznym.

Zachowanie właściwości:
- wymagane, jeśli type jest ustawione na "SSH" i authtype jest ustawione na "public key"
privatekey string Nazwa pliku klucza prywatnego używanego dla skryptów SSH z uwierzytelnianiem kluczem publicznym.

Zachowanie właściwości:
- wymagane, jeśli type jest ustawione na "SSH" i authtype jest ustawione na "public key"
port string Numer portu używany dla skryptów SSH i TELNET.

Zachowanie właściwości:
- obsługiwane, jeśli type jest ustawione na "SSH" lub "TELNET"
groupid ID ID grupy hostów, na której można uruchomić skrypt.

Jeśli ustawione na "0", skrypt będzie dostępny dla wszystkich grup hostów.

Domyślnie: 0.
usrgrpid ID ID grupy użytkowników, która będzie uprawniona do uruchamiania skryptu.

Jeśli ustawione na "0", skrypt będzie dostępny dla wszystkich grup użytkowników.

Domyślnie: 0.

Zachowanie właściwości:
- obsługiwane, jeśli scope jest ustawione na "manual host action" lub "manual event action"
host_access integer Uprawnienia do hosta wymagane do uruchomienia skryptu.

Możliwe wartości:
2 - (domyślnie) odczyt;
3 - zapis.

Zachowanie właściwości:
- obsługiwane, jeśli scope jest ustawione na "manual host action" lub "manual event action"
confirmation string Tekst wyskakującego okna potwierdzenia.
Okno wyskakujące pojawi się podczas próby uruchomienia skryptu z frontend Zabbix.

Zachowanie właściwości:
- obsługiwane, jeśli scope jest ustawione na "manual host action" lub "manual event action"
timeout string Limit czasu wykonania skryptu webhook w sekundach. Obsługiwane są sufiksy czasu (np. 30s, 1m).

Możliwe wartości: 1-60s.

Domyślnie: 30s.

Zachowanie właściwości:
- wymagane, jeśli type jest ustawione na "Webhook"
parameters array Tablica parametrów wejściowych webhooka.

Zachowanie właściwości:
- obsługiwane, jeśli type jest ustawione na "Webhook"
description string Opis skryptu.
url string URL zdefiniowany przez użytkownika.

Zachowanie właściwości:
- wymagane, jeśli type jest ustawione na "URL"
new_window integer Otwórz URL w nowym oknie.

Możliwe wartości:
0 - Nie;
1 - (domyślnie) Tak.

Zachowanie właściwości:
- obsługiwane, jeśli type jest ustawione na "URL"
manualinput integer Wskazuje, czy skrypt akceptuje dane wejściowe podane przez użytkownika.

Możliwe wartości:
0 - (domyślnie) Wyłączone;
1 - Włączone;

Zachowanie właściwości:
- obsługiwane, jeśli scope jest ustawione na "manual host action" lub "manual event action"
manualinput_prompt string Tekst monitu dla ręcznego wprowadzania danych.

Zachowanie właściwości:
- wymagane, jeśli manualinput jest ustawione na "Enabled"
manualinput_validator string Pole tekstowe używane do walidacji danych wejściowych podanych przez użytkownika. Ciąg składa się albo z wyrażenia regularnego, albo z zestawu wartości oddzielonych przecinkami.

Zachowanie właściwości:
- wymagane, jeśli manualinput jest ustawione na "Enabled"
manualinput_validator_type integer Określa oczekiwany typ danych wejściowych użytkownika.

Możliwe wartości:
0 - (domyślnie) String. Oznacza, że manualinput_validator ma być traktowane jako wyrażenie regularne;
1 - List. Oznacza, że manualinput_validator ma być traktowane jako lista możliwych wartości wejściowych oddzielonych przecinkami.

Zachowanie właściwości:
- obsługiwane, jeśli manualinput jest ustawione na "Enabled"
manualinput_default_value string Wartość domyślna do automatycznego uzupełniania danych wejściowych użytkownika.

Zachowanie właściwości:
- obsługiwane, jeśli manualinput_validator_type jest ustawione na "String"

Parametry webhooka

Parametry przekazywane do skryptu webhooka podczas jego wywołania mają następujące właściwości.

Właściwość Typ Opis
name string Nazwa parametru.

Zachowanie właściwości:
- wymagane
value string Wartość parametru. Obsługuje makra.

Debug

Informacje debugowania wykonanego skryptu webhook. Obiekt debug ma następujące właściwości.

Właściwość Type Opis
logs array Tablica wpisów dziennika.
ms string Czas wykonywania skryptu w milisekundach.

Wpis dziennika

Obiekt wpisu dziennika ma następujące właściwości.

Właściwość Typ Opis
level integer Poziom dziennika.
ms string Czas, który upłynął w milisekundach od uruchomienia skryptu do momentu dodania wpisu dziennika.
message string Komunikat dziennika.