Skrypty
Przegląd
W sekcji Alerts > Scripts można konfigurować i utrzymywać globalne skrypty definiowane przez użytkownika.
To menu jest dostępne wyłącznie dla użytkowników typu SuperAdmin.
Globalne skrypty, w zależności od skonfigurowanego zakresu, a także uprawnień użytkownika, są dostępne do uruchomienia:
- Z menu hosta w różnych lokalizacjach frontend (Dashboard, Problems, Latest data, Maps itd.).
- Z menu zdarzeń.
- Mogą być uruchamiane jako operacja akcji.
Skrypty są wykonywane na agent, serwer Zabbix (proxy) lub wyłącznie na serwer Zabbix Zobacz także Command execution.
Zarówno na agent, jak i na proxy Zabbix zdalne skrypty są domyślnie wyłączone. Można je włączyć przez:
- Dla zdalnych poleceń wykonywanych na agent Zabbix:
- dodanie parametru
AllowKey=system.run[<command>,*]dla każdego dozwolonego polecenia w konfiguracji agenta,*oznacza tryb wait i nowait;
- dodanie parametru
- Dla zdalnych poleceń wykonywanych na proxy Zabbix:
- Ostrzeżenie: Nie jest wymagane włączanie zdalnych poleceń na proxy Zabbix, jeśli zdalne polecenia są wykonywane na agent Zabbix monitorowanym przez proxy Zabbix. Jeśli jednak konieczne jest wykonywanie zdalnych poleceń na proxy Zabbix, należy ustawić parametr EnableRemoteCommands na '1' w konfiguracji proxy.
Wykonywanie globalnych skryptów na serwer Zabbix można wyłączyć, ustawiając EnableGlobalScripts=0 w konfiguracji serwera.
W przypadku nowych instalacji, od Zabbix 7.0, wykonywanie globalnych skryptów na serwer Zabbix jest domyślnie wyłączone.
Wyświetlana jest lista istniejących skryptów wraz ze szczegółami.
Wyświetlane dane:
| Column | Description |
|---|---|
| Name | Nazwa skryptu. Kliknięcie nazwy skryptu otwiera formularz konfiguracji skryptu. |
| Scope | Zakres skryptu - operacja akcji, ręczna akcja hosta lub ręczna akcja zdarzenia. To ustawienie określa, gdzie skrypt jest dostępny - odpowiednio w zdalnych poleceniach operacji, z menu hosta lub z menu zdarzeń. |
| Used in actions | Wyświetlane są wszystkie akcje, w których używany jest skrypt, poprzedzone łączną liczbą tych akcji. Kliknięcie nazwy akcji otwiera formularz konfiguracji akcji. Jeśli użytkownik nie ma uprawnień do akcji, nazwa nie jest klikalna. |
| Type | Wyświetlany jest typ skryptu - polecenie URL, Webhook, Script, SSH, Telnet lub IPMI. |
| Execute on | Wyświetla, czy skrypt będzie wykonywany na agent, proxy lub serwer, czy wyłącznie na serwer Zabbix. |
| Commands | Wyświetlane są wszystkie polecenia, które mają zostać wykonane w ramach skryptu. W przypadku webhooków nic tutaj nie jest wyświetlane. |
| User group | Wyświetlana jest grupa użytkowników, dla której skrypt jest dostępny (lub All dla wszystkich grup użytkowników). |
| Host group | Wyświetlana jest grupa hostów, dla której skrypt jest dostępny (lub All dla wszystkich grup hostów). |
| Host access | Wyświetlany jest poziom uprawnień dla grupy hostów - Read lub Write. Dostęp do uruchomienia skryptu będą mieli tylko użytkownicy z wymaganym poziomem uprawnień. |
Aby skonfigurować nowy skrypt, kliknij przycisk Create script w prawym górnym rogu.
Opcje masowej edycji
Przycisk poniżej listy oferuje jedną opcję masowej edycji:
- Usuń - usuń skrypty
Aby użyć tej opcji, zaznacz pola wyboru przed odpowiednimi skryptami i kliknij Usuń.
Korzystanie z filtra
Możesz użyć filtra, aby wyświetlić tylko interesujące Cię skrypty. Aby poprawić wydajność wyszukiwania, dane są przeszukiwane z nierozwiązanymi makrami.
Łącze Filter jest dostępne nad listą skryptów. Po jego kliknięciu pojawi się filtr, za pomocą którego możesz filtrować skrypty według nazwy i zakresu.
Konfigurowanie skryptu globalnego
W celu zwiększenia bezpieczeństwa zaleca się używanie funkcji makr zamiast zwykłych makr w skryptach globalnych, ponieważ makra nie są automatycznie zabezpieczane.
Atrybuty skryptu:
| Parametr | Opis | |
|---|---|---|
| Nazwa | Unikalna nazwa skryptu. Na przykład: Clear /tmp filesystem |
|
| Zakres | Zakres skryptu - operacja działania, ręczna akcja na hoście lub ręczna akcja na zdarzeniu. To ustawienie określa, gdzie można używać skryptu - w zdalnych poleceniach operacji działania, z menu hosta lub z menu zdarzenia. Ustawienie zakresu na „Operacja działania” udostępnia skrypt wszystkim użytkownikom mającym dostęp do Alerty > Działania. Jeśli skrypt jest używany w działaniu, jego zakresu nie można zmienić z „operacja działania”. Obsługa makr Zakres wpływa na zestaw dostępnych makr. Na przykład makra związane z użytkownikiem ( {USER.*}) są obsługiwane w skryptach, aby umożliwić przekazywanie informacji o użytkowniku, który uruchomił skrypt. Nie są jednak obsługiwane, jeśli zakresem skryptu jest operacja działania, ponieważ operacje działań są wykonywane automatycznie.Makro {MANUALINPUT} umożliwia określenie danych wejściowych podczas wykonywania skryptu. Jest obsługiwane w skryptach ręcznych akcji na hoście i ręcznych akcji na zdarzeniu. Aby sprawdzić, które inne makra są obsługiwane, wyszukaj pozycje „Trigger-based notifications and commands/Trigger-based commands”, „Manual host action scripts” oraz „Manual event action scripts” w tabeli obsługiwanych makr. Pamiętaj, że jeśli makro może zostać rozwinięte do wartości zawierającej spacje (na przykład nazwa hosta), należy w razie potrzeby użyć cudzysłowów. |
|
| Ścieżka menu | Żądana ścieżka menu skryptu. Na przykład Default lub Default/ spowoduje wyświetlenie skryptu w odpowiednim katalogu. Menu mogą być zagnieżdżane, np. Main menu/Sub menu1/Sub menu2. Podczas uzyskiwania dostępu do skryptów za pośrednictwem menu hosta/zdarzenia w sekcjach monitorowania będą one uporządkowane zgodnie z podanymi katalogami.To pole jest wyświetlane tylko wtedy, gdy jako Zakres wybrano „Ręczna akcja na hoście” lub „Ręczna akcja na zdarzeniu”. |
|
| Typ | Kliknij odpowiedni przycisk, aby wybrać typ skryptu: URL, Webhook, Skrypt, SSH, Telnet lub polecenie IPMI. Typ URL jest dostępny tylko wtedy, gdy jako Zakres wybrano „Ręczna akcja na hoście” lub „Ręczna akcja na zdarzeniu”. |
|
| Typ skryptu: URL | ||
| URL | Określ adres URL zapewniający szybki dostęp z menu hosta lub menu zdarzenia. Obsługiwane są makra i niestandardowe makra użytkownika. Obsługa makr zależy od zakresu skryptu (zobacz powyżej Zakres). Użyj makra {MANUALINPUT} w tym polu, aby móc określić dane wejściowe podczas wykonywania skryptu, na przykład: http://{MANUALINPUT}/zabbix/zabbix.php?action=dashboard.viewWartości makr nie mogą być kodowane w formacie URL. |
|
| Otwórz w nowym oknie | Określa, czy adres URL powinien zostać otwarty w nowej, czy w tej samej karcie przeglądarki. | |
| Typ skryptu: Webhook | ||
| Parametry | Określ zmienne webhooka jako pary atrybut-wartość. Zobacz także: konfiguracja mediów typu Webhook. Wartości parametrów mogą zawierać makra i niestandardowe makra użytkownika. Obsługa makr zależy od zakresu skryptu (zobacz powyżej Zakres). |
|
| Skrypt | Wprowadź kod JavaScript w edytorze modalnym, który otwiera się po kliknięciu pola parametru lub ikony ołówka obok niego. Obsługa makr zależy od zakresu skryptu (zobacz powyżej Zakres). Zobacz także: konfiguracja mediów typu Webhook, Dodatkowe obiekty JavaScript. |
|
| Limit czasu | Limit czasu wykonywania JavaScript (1-60 s, domyślnie 30 s). Obsługiwane są przyrostki czasu (np. 30s, 1m). |
|
| Typ skryptu: Skrypt | ||
| Wykonaj na | Kliknij odpowiedni przycisk, aby wykonać skrypt powłoki na: Zabbix agent - skrypt zostanie wykonany przez Zabbix agent (jeśli pozycja system.run jest dozwolona) na hoście Zabbix proxy lub serwer - skrypt zostanie wykonany przez Zabbix proxy lub serwer, zależnie od tego, czy host jest monitorowany przez proxy czy serwer. Zostanie wykonany na proxy, jeśli włączono tę funkcję za pomocą EnableRemoteCommands. Zostanie wykonany na serwerze, jeśli skrypty globalne są włączone za pomocą parametru serwera EnableGlobalScripts. Zabbix serwer - skrypt zostanie wykonany wyłącznie przez Zabbix serwer. Ta opcja nie będzie dostępna, jeśli skrypty globalne są wyłączone za pomocą parametru serwera EnableGlobalScripts. |
|
| Polecenia | Wprowadź pełną ścieżkę do poleceń, które mają zostać wykonane w ramach skryptu. Obsługa makr zależy od zakresu skryptu (zobacz powyżej Zakres). Obsługiwane są niestandardowe makra użytkownika. |
|
| Typ skryptu: SSH | ||
| Metoda uwierzytelniania | Wybierz metodę uwierzytelniania - hasło lub klucz publiczny. | |
| Nazwa użytkownika | Wprowadź nazwę użytkownika. | |
| Hasło | Wprowadź hasło. To pole jest dostępne, jeśli jako metodę uwierzytelniania wybrano „Hasło”. |
|
| Plik klucza publicznego | Wprowadź ścieżkę do pliku klucza publicznego. To pole jest dostępne, jeśli jako metodę uwierzytelniania wybrano „Klucz publiczny”. |
|
| Plik klucza prywatnego | Wprowadź ścieżkę do pliku klucza prywatnego. To pole jest dostępne, jeśli jako metodę uwierzytelniania wybrano „Klucz publiczny”. |
|
| Hasło klucza | Wprowadź hasło klucza. To pole jest dostępne, jeśli jako metodę uwierzytelniania wybrano „Klucz publiczny”. |
|
| Port | Wprowadź port zdalnej usługi SSH na docelowym hoście, z którym Zabbix nawiąże połączenie. | |
| Polecenia | Wprowadź polecenia. Obsługa makr zależy od zakresu skryptu (zobacz powyżej Zakres). Obsługiwane są niestandardowe makra użytkownika. |
|
| Typ skryptu: Telnet | ||
| Nazwa użytkownika | Wprowadź nazwę użytkownika. | |
| Hasło | Wprowadź hasło. | |
| Port | Wprowadź port zdalnej usługi Telnet na docelowym hoście, z którym Zabbix nawiąże połączenie. | |
| Polecenia | Wprowadź polecenia. Obsługa makr zależy od zakresu skryptu (zobacz powyżej Zakres). Obsługiwane są niestandardowe makra użytkownika. |
|
| Typ skryptu: IPMI | ||
| Polecenie | Wprowadź polecenie IPMI. Obsługa makr zależy od zakresu skryptu (zobacz powyżej Zakres). Obsługiwane są niestandardowe makra użytkownika. |
|
| Opis | Wprowadź opis skryptu. | |
| Grupa hostów | Wybierz grupę hostów, dla której skrypt będzie dostępny (lub Wszystkie dla wszystkich grup hostów). | |
| Grupa użytkowników | Wybierz grupę użytkowników, dla której skrypt będzie dostępny (lub Wszystkie dla wszystkich grup użytkowników). To pole jest wyświetlane tylko wtedy, gdy jako Zakres wybrano „Ręczna akcja na hoście” lub „Ręczna akcja na zdarzeniu”. |
|
| Wymagane uprawnienia do hosta | Wybierz poziom uprawnień dla grupy hostów - Odczyt lub Zapis. Tylko użytkownicy z wymaganym poziomem uprawnień będą mieć dostęp do wykonywania skryptu. To pole jest wyświetlane tylko wtedy, gdy jako Zakres wybrano „Ręczna akcja na hoście” lub „Ręczna akcja na zdarzeniu”. |
|
| Konfiguracja zaawansowana | Kliknij nagłówek Konfiguracja zaawansowana, aby wyświetlić opcje konfiguracji zaawansowanej. To pole jest wyświetlane tylko wtedy, gdy jako Zakres wybrano „Ręczna akcja na hoście” lub „Ręczna akcja na zdarzeniu”. |
|
Zaawansowana konfiguracja
Opcje zaawansowanej konfiguracji są dostępne w zwijanej sekcji Zaawansowana konfiguracja:
| Parameter | Description |
|---|---|
| Włącz dane wejściowe użytkownika | Zaznacz pole wyboru, aby włączyć ręczne dane wejściowe użytkownika przed wykonaniem skryptu. Ręczne dane wejściowe użytkownika zastąpią wartość makra {MANUALINPUT} w skrypcie. Zobacz także: Ręczne dane wejściowe użytkownika. |
| Monit wejściowy | Wprowadź własny tekst z prośbą o podanie niestandardowych danych wejściowych użytkownika. Ten tekst zostanie wyświetlony nad polem wejściowym w oknie podręcznym Ręczne dane wejściowe. Aby zobaczyć podgląd okna podręcznego Ręczne dane wejściowe, kliknij Testuj dane wejściowe użytkownika. Podgląd umożliwia również sprawdzenie, czy ciąg wejściowy jest zgodny z regułą walidacji danych wejściowych (zobacz parametry poniżej). Obsługa makr i makr użytkownika zależy od zakresu skryptu (zobacz Zakres w ogólnych parametrach konfiguracji skryptu). |
| Typ danych wejściowych | Wybierz typ ręcznych danych wejściowych: String - pojedynczy ciąg; Dropdown - wartość jest wybierana spośród wielu opcji listy rozwijanej. |
| Opcje listy rozwijanej | Wprowadź unikalne wartości dla listy rozwijanej danych wejściowych użytkownika jako listę rozdzielaną przecinkami. Aby uwzględnić pustą opcję na liście rozwijanej, dodaj dodatkowy przecinek na początku, w środku lub na końcu listy. To pole jest wyświetlane tylko wtedy, gdy jako Typ danych wejściowych wybrano opcję 'Dropdown'. |
| Domyślny ciąg wejściowy | Wprowadź domyślny ciąg dla danych wejściowych użytkownika (lub brak). To pole zostanie zweryfikowane względem wyrażenia regularnego podanego w polu Reguła walidacji danych wejściowych. Wprowadzona tutaj wartość będzie domyślnie wyświetlana w oknie podręcznym Ręczne dane wejściowe. To pole jest wyświetlane tylko wtedy, gdy jako Typ danych wejściowych wybrano opcję 'String'. |
| Reguła walidacji danych wejściowych | Wprowadź wyrażenie regularne do walidacji ciągu danych wejściowych użytkownika. Obsługiwane są globalne wyrażenia regularne. To pole jest wyświetlane tylko wtedy, gdy jako Typ danych wejściowych wybrano opcję 'String'. |
| Włącz potwierdzenie | Zaznacz pole wyboru, aby wyświetlić komunikat potwierdzenia przed wykonaniem skryptu. Ta funkcja może być szczególnie przydatna w przypadku potencjalnie niebezpiecznych operacji (takich jak skrypt restartu) lub takich, które mogą trwać długo. |
| Tekst potwierdzenia | Wprowadź własny tekst potwierdzenia dla okna podręcznego potwierdzenia włączonego za pomocą powyższego pola wyboru (na przykład Zdalny system zostanie uruchomiony ponownie. Czy na pewno?). Aby zobaczyć, jak będzie wyglądał tekst, kliknij Testuj potwierdzenie obok pola. Obsługiwane są makra oraz niestandardowe makra użytkownika. Uwaga: makra nie zostaną rozwinięte podczas testowania komunikatu potwierdzenia. |
Jeśli skonfigurowano zarówno ręczne dane wejściowe użytkownika, jak i komunikat potwierdzenia, zostaną one wyświetlone w kolejnych oknach podręcznych.
Ręczne dane wejściowe użytkownika
Ręczne dane wejściowe użytkownika pozwalają podać własny parametr przy każdym uruchomieniu skryptu. Eliminuje to konieczność tworzenia wielu podobnych skryptów użytkownika różniących się tylko jednym parametrem.
Na przykład podczas uruchamiania skryptu można chcieć podać inną liczbę całkowitą lub inny adres URL.
Aby włączyć ręczne dane wejściowe użytkownika:
- użyj makra {MANUALINPUT} w skrypcie (polecenia, skrypt, parametr skryptu) tam, gdzie jest to wymagane; lub w polu URL w skryptach URL;
- w zaawansowanej konfiguracji skryptu włącz ręczne dane wejściowe użytkownika i skonfiguruj opcje wejściowe.
Po włączeniu danych wejściowych użytkownika, przed wykonaniem skryptu użytkownikowi zostanie wyświetlone wyskakujące okno Ręczne dane wejściowe z prośbą o podanie własnej wartości. Podana wartość zastąpi {MANUALINPUT} w skrypcie.
W zależności od konfiguracji użytkownik zostanie poproszony o wprowadzenie wartości tekstowej:
Lub o wybranie wartości z listy rozwijanej wcześniej zdefiniowanych opcji:
Ręczne dane wejściowe użytkownika są dostępne tylko dla skryptów, w których zakres to „Ręczna akcja hosta” lub „Ręczna akcja zdarzenia”.
Wykonywanie skryptu i wynik
Skrypty uruchamiane przez serwer Zabbix są wykonywane w kolejności opisanej na stronie wykonywania poleceń.
Wynik skryptu jest wyświetlany w wyskakującym oknie, które pojawia się po uruchomieniu skryptu. Wartością zwracaną skryptu jest standardowe wyjście:
- Jeśli skrypt zakończy się pomyślnie (kod wyjścia
0), wartość zwracana jest ograniczona do 16 MB (włącznie z końcowymi białymi znakami, które są obcinane). - Jeśli skrypt zakończy się błędem (niezerowy kod wyjścia), wartością zwracaną jest standardowe wyjście błędów ograniczone do 2 KB.
Domyślnie Zabbix nie przechowuje rozszerzonego wyjścia skryptu. Aby zachować pełne szczegóły wyjścia, można zaimplementować rejestrowanie w samym skrypcie (np. przekierować wyjście do lokalnego pliku dziennika).
Należy pamiętać, że w przypadku skryptów wykonywanych zarówno na serwerze Zabbix, jak i na Zabbix proxy, obowiązują również ograniczenia bazy danych.
Poniżej znajduje się przykład skryptu i okna wyniku:
uname -v
/tmp/non_existing_script.sh
echo "This script was started by {USER.USERNAME}"
Wynik skryptu nie wyświetla samego skryptu.
Przekroczenie czasu skryptu na agent
Może wystąpić sytuacja, w której podczas wykonywania skryptu nastąpi przekroczenie czasu.
Poniżej przedstawiono przykład skryptu uruchamianego na agent oraz okno z wynikiem:
sleep 5
df -h
W takim przypadku komunikat o błędzie ma następującą treść:
Timeout while executing a shell script.Aby uniknąć takich sytuacji, zaleca się optymalizację samego skryptu (w powyższym przykładzie: "5"), zamiast dostosowywania parametru Timeout w konfiguracji agent Zabbix oraz konfiguracji serwer Zabbix.
Jeśli parametr Timeout został zmieniony w konfiguracji agent Zabbix, pojawi się następujący komunikat o błędzie:
Get value from agent failed: ZBX_TCP_READ() timed out.Oznacza to, że zmiana została wprowadzona w konfiguracji agent Zabbix, ale konieczna jest również modyfikacja parametru Timeout w konfiguracji serwer Zabbix.
Limit czasu skryptu na agentach aktywnych
Możliwe jest wykonywanie skryptów na agentach działających wyłącznie w trybie aktywnym. Gdy wykonanie skryptu zostanie wyzwolone przez operację akcji lub ręczne uruchomienie skryptu, polecenie jest dołączane do konfiguracji aktywnego sprawdzania i wykonywane, gdy aktywny agent je otrzyma.
Skrypty uruchamiane ręcznie są wysyłane do aktywnego agenta wraz z limitem czasu serwer/proxy dla wykonania skryptu. Zwiększ domyślny limit czasu serwer/proxy dla wykonania skryptu. Limit czasu musi być większy niż częstotliwość odświeżania aktywnego sprawdzania, w przeciwnym razie limit czasu zostanie przekroczony, zanim aktywny agent otrzyma skrypt i będzie mógł zwrócić wynik.
Limit czasu skryptu na serwerze/proxy Zabbix
Poniżej przedstawiono przykład skryptu uruchamianego na serwerze Zabbix oraz okno z wynikiem:
sleep 11
df -h
Zaleca się również zoptymalizowanie samego skryptu (zamiast dostosowywania parametru TrapperTimeout do odpowiedniej wartości (w naszym przypadku, > 11) poprzez modyfikację konfiguracji serwera Zabbix).