Documentation
Table of Contents
> Script object
Poniższe obiekty są bezpośrednio powiązane z interfejsem API script.
Script
Obiekt script posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| scriptid | string | (tylko do odczytu) ID skryptu. |
| name (wymagane) |
string | Nazwa skryptu. |
| type (wymagane) |
integer | Typ skryptu. Możliwe wartości: 0 - Skrypt; 1 - IPMI; 2 - SSH; 3 - Telnet; 5 - (domyślnie) Webhook. |
| command (wymagane) |
string | Polecenie do wykonania. |
| scope | integer | Zakres skryptu. Możliwe wartości: 1 - domyślnie operacja akcji; 2 - ręczna akcja na hoście; 4 - ręczna akcja na zdarzeniu. |
| execute_on | integer | Gdzie uruchomić skrypt. Używane, jeśli type to 0 (skrypt).Możliwe wartości: 0 - uruchom na agencie Zabbix; 1 - uruchom na serwerze Zabbix; 2 - (domyślnie) uruchom na serwerze Zabbix (proxy). |
| menu_path | string | Foldery oddzielone ukośnikami, które tworzą nawigację menu w interfejsie, kiedy kliknięmyHost na hoście lub zdarzeniu. Używane, jeśli scope to 2 lub 4. |
| authtype | integer | Metoda uwierzytelniania używana dla typu skryptu SSH. Używane, jeśli type to 2.Możliwe wartości: 0 - hasło; 1 - klucz publiczny. |
| username | string | Nazwa użytkownika używana do uwierzytelnienia. Wymagane, jeśli type to 2 lub 3. |
| password | string | Hasło używane dla skryptów SSH z uwierzytelnianiem hasłem i skryptów Telnet. Używane, jeśli type to 2 i authtype to 0 lub type to 3. |
| publickey | string | Nazwa pliku klucza publicznego używanego do skryptów SSH z uwierzytelnianiem kluczem publicznym. Wymagane, jeśli typ to 2 i authtype to 1. |
| privatekey | string | Nazwa pliku klucza prywatnego używanego do skryptów SSH z uwierzytelnianiem kluczem publicznym. Wymagane, jeśli typ to 2 i authtype to 1. |
| port | string | Numer portu używany dla skryptów SSH i Telnet. Używane, jeśli typ to 2 lub 3. |
| groupid | string | ID grupy hostów, na której można uruchomić skrypt. Jeśli ustawione na 0, skrypt będzie dostępny we wszystkich grupach hostów. Domyślne: 0. |
| usrgrpid | string | ID grupy użytkowników, która będzie mogła uruchomić skrypt. Jeśli ustawione na 0, skrypt będzie dostępny dla wszystkich grup użytkowników. Używane, jeśli scope to 2 lub 4.Domyślne: 0. |
| host_access | integer | Uprawnienia hosta potrzebne do uruchomienia skryptu. Używane, jeśli scope to 2 lub 4.Możliwe wartości: 2 - (domyślnie) odczyt; 3 - zapis. |
| confirmation | string | Tekst potwierdzenia w wyskakującym oknie. Okno pojawi się podczas próby uruchomienia skryptu z interfejsu Zabbixa. Używane, jeśli scope to 2 lub 4. |
| timeout | string | Limit czasu wykonania skryptu webhooka w sekundach. Obsługiwane są sufiksy czasowe, np. 30s, 1m. Wymagane, jeśli type to 5.Możliwe wartości: 1-60s Wartość domyślna: 30s |
| parameters | array | Tablica parametrów wejściowych webhooka. Używane, jeśli type to 5. |
| description | string | Opis skryptu. |
Zauważ, że dla niektórych metod (update, delete) kombinacja parametrów wymaganych/opcjonalnych jest inna.
Webhook parameters
Parametry przekazywane do skryptu webhooka podczas jego wywołania posiadają następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| name (wymagane) |
string | Nazwa parametru. |
| value | string | Wartość parametru. Obsługuje makra. |
Debug
Informacje debugowania wykonanego skryptu webhooka. Obiekt debug posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| logs | array | Tablica wpisów logu. |
| ms | string | Czas trwania wykonania skryptu w milisekundach. |
Log entry
Obiekt log entry posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| level | integer | Poziom logu. |
| ms | string | Czas upływający w milisekundach od uruchomienia skryptu przed dodaniem wpisu logu. |
| message | string | Wartość logu. |