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.

Property Type Description
scriptid ID Identyfikator 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 - Skrypt;
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 Miejsce uruchomienia skryptu.

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

Zachowanie właściwości:
- obsługiwane, jeśli type jest ustawione na „Script”
menu_path string Foldery rozdzielone ukośnikami, które po kliknięciu hosta lub zdarzenia tworzą w frontend nawigację przypominającą menu.

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 w skryptach SSH z uwierzytelnianiem za pomocą hasła oraz w skryptach TELNET.

Zachowanie właściwości:
- obsługiwane, jeśli type jest ustawione na „SSH”, a authtype na „password”, lub jeśli type jest ustawione na „TELNET”
publickey string Nazwa pliku klucza publicznego używanego w skryptach SSH z uwierzytelnianiem za pomocą klucza publicznego.

Zachowanie właściwości:
- wymagane, jeśli type jest ustawione na „SSH”, a authtype na „public key”
privatekey string Nazwa pliku klucza prywatnego używanego w skryptach SSH z uwierzytelnianiem za pomocą klucza publicznego.

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

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

Jeśli ustawiono wartość „0”, skrypt będzie dostępny we wszystkich grupach hostów.

Wartość domyślna: 0.
usrgrpid ID Identyfikator grupy użytkowników, która będzie mogła uruchamiać skrypt.

Jeśli ustawiono wartość „0”, skrypt będzie dostępny dla wszystkich grup użytkowników.

Wartość domyślna: 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 okna potwierdzenia.
Okno 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 wykonywania skryptu webhook w sekundach. Obsługiwane są przyrostki czasu (np. 30s, 1m).

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

Wartość domyślna: 30s.

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

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 Otwieranie 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 Określa, 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 o dane wejściowe.

Zachowanie właściwości:
- wymagane, jeśli manualinput jest ustawione na „Enabled”
manualinput_validator string Pole tekstowe używane do sprawdzania danych wejściowych podanych przez użytkownika. Ciąg składa się z wyrażenia regularnego lub zestawu wartości rozdzielonych 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) Ciąg. Wskazuje, że manualinput_validator należy traktować jako wyrażenie regularne;
1 - Lista. Wskazuje, że manualinput_validator należy traktować jako rozdzielaną przecinkami listę możliwych wartości wejściowych.

Zachowanie właściwości:
- obsługiwane, jeśli manualinput jest ustawione na „Enabled”
manualinput_default_value string Wartość domyślna używana do automatycznego wypeł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.