Obiekt typu mediów

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

Typ medium

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

Property Type Description
mediatypeid ID ID typu medium.

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

Zachowanie właściwości:
- wymagane dla operacji tworzenia
type integer Transport używany przez typ medium.

Możliwe wartości:
0 - Email;
1 - Script;
2 - SMS;
4 - Webhook.

Zachowanie właściwości:
- wymagane dla operacji tworzenia
exec_path string Nazwa pliku skryptu (np. notification.sh), który znajduje się w katalogu określonym w parametrze konfiguracji serwera AlertScriptsPath.

Zachowanie właściwości:
- wymagane jeśli type jest ustawione na "Script"
gsm_modem string Nazwa urządzenia szeregowego modemu GSM.

Zachowanie właściwości:
- wymagane jeśli type jest ustawione na "SMS"
passwd string Hasło uwierzytelniania.

Zachowanie właściwości:
- obsługiwane jeśli smtp_authentication jest ustawione na "Normal password"
provider integer Dostawca poczty e-mail.

Możliwe wartości:
0 - (domyślnie) Generic SMTP;
1 - Gmail;
2 - Gmail relay;
3 - Office365;
4 - Office365 relay.
smtp_email string Adres e-mail, z którego będą wysyłane powiadomienia.

Zachowanie właściwości:
- wymagane jeśli type jest ustawione na "Email"
smtp_helo string SMTP HELO.

Zachowanie właściwości:
- obsługiwane jeśli type jest ustawione na "Email"
smtp_server string Serwer SMTP.

Zachowanie właściwości:
- wymagane jeśli type jest ustawione na "Email"
smtp_port integer Port serwera SMTP, z którym należy się połączyć.

Domyślnie: 25.

Zachowanie właściwości:
- obsługiwane jeśli type jest ustawione na "Email"
smtp_security integer Poziom zabezpieczeń połączenia SMTP do użycia.

Możliwe wartości:
0 - (domyślnie) Brak;
1 - STARTTLS;
2 - SSL/TLS.

Zachowanie właściwości:
- obsługiwane jeśli type jest ustawione na "Email"
smtp_verify_host integer Weryfikacja hosta SSL dla SMTP.

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

Zachowanie właściwości:
- obsługiwane jeśli smtp_security jest ustawione na "STARTTLS" lub "SSL/TLS"
smtp_verify_peer integer Weryfikacja peer SSL dla SMTP.

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

Zachowanie właściwości:
- obsługiwane jeśli smtp_security jest ustawione na "STARTTLS" lub "SSL/TLS"
smtp_authentication integer Metoda uwierzytelniania SMTP do użycia.

Możliwe wartości:
0 - (domyślnie) Brak;
1 - Normal password;
2 - OAuth token.
Uwierzytelnianie OAuth nie jest dozwolone dla dostawcy poczty e-mail Office365 relay.

Zachowanie właściwości:
- obsługiwane jeśli type jest ustawione na "Email"
redirection_url string Adres URL frontend Zabbix, na który następuje przekierowanie po autoryzacji OAuth.

Domyślnie:
Wartość właściwości url ustawień API z częścią zabbix.php?action=oauth.authorize

Zachowanie właściwości:
- wymagane jeśli smtp_authentication jest ustawione na "OAuth token"
client_id string Identyfikator klienta zarejestrowany w serwerze autoryzacji OAuth.

Zachowanie właściwości:
- wymagane jeśli smtp_authentication jest ustawione na "OAuth token"
client_secret string Sekret klienta zarejestrowany w serwerze autoryzacji OAuth. Dostępny tylko dla użytkownika typu Super Admin.

Zachowanie właściwości:
- wymagane jeśli smtp_authentication jest ustawione na "OAuth token"
authorization_url string Adres URL OAuth z parametrami do uzyskania tokenów dostępu i odświeżania.

Zachowanie właściwości:
- wymagane jeśli smtp_authentication jest ustawione na "OAuth token"
token_url string Adres URL OAuth do wymiany tokenu autoryzacji na tokeny dostępu i odświeżania.
Ten adres URL jest również używany przez serwer do odświeżania nieprawidłowego tokenu dostępu.

Zachowanie właściwości:
- wymagane jeśli smtp_authentication jest ustawione na "OAuth token"
tokens_status integer Maska bitowa statusu tokenów.

Możliwe wartości:
0 - (domyślnie) Oba tokeny zawierają nieprawidłową wartość
1 - Token dostępu zawiera prawidłową wartość
2 - Token odświeżania zawiera prawidłową wartość
3 - Oba tokeny zawierają prawidłową wartość.

Zachowanie właściwości:
- obsługiwane jeśli smtp_authentication jest ustawione na "OAuth token"
access_token string Wartość tokenu dostępu OAuth.

Zachowanie właściwości:
- wymagane jeśli smtp_authentication jest ustawione na "OAuth token"
access_token_updated timestamp Znacznik czasu ostatniej modyfikacji access_token wykonanej przez serwer podczas odświeżania za pomocą refresh_token lub przez API przy zmianie tokenów.

Zachowanie właściwości:
- obsługiwane jeśli smtp_authentication jest ustawione na "OAuth token"
access_expires_in integer Czas w sekundach, po którym access_token stanie się nieaktualny i będzie wymagał wysłania żądania do refresh_url.
Jest ustawiany przez serwer Zabbix podczas odświeżania access_token lub przez API przy zmianie tokenów.

Znacznik czasu jest obliczany przez dodanie wartości access_token_updated.

Zachowanie właściwości:
- obsługiwane jeśli smtp_authentication jest ustawione na "OAuth token"
refresh_token string Wartość tokenu odświeżania OAuth.

Zachowanie właściwości:
- wymagane jeśli smtp_authentication jest ustawione na "OAuth token"
status integer Określa, czy typ medium jest włączony.

Możliwe wartości:
0 - (domyślnie) Włączony;
1 - Wyłączony.
username string Nazwa użytkownika.

Zachowanie właściwości:
- obsługiwane jeśli smtp_authentication jest ustawione na "Normal password"
maxsessions integer Maksymalna liczba alertów, które mogą być przetwarzane równolegle.

Możliwe wartości jeśli type jest ustawione na "SMS": 1.

Możliwe wartości jeśli type jest ustawione na "Email", "Script" lub "Webhook": 0-100.

Domyślnie: 1.
maxattempts integer Maksymalna liczba prób wysłania alertu.

Możliwe wartości: 1-100.

Domyślnie: 3.
attempt_interval string Interwał między próbami ponowienia.
Akceptuje sekundy oraz jednostkę czasu z sufiksem.

Możliwe wartości: 0-1h.

Domyślnie: 10s.
message_format integer Format wiadomości.

Możliwe wartości:
0 - Zwykły tekst;
1 - (domyślnie) HTML.

Zachowanie właściwości:
- obsługiwane jeśli type jest ustawione na "Email"
script text Treść skryptu webhooka (JavaScript).

Zachowanie właściwości:
- wymagane jeśli type jest ustawione na "Webhook"
timeout string Limit czasu skryptu webhooka.
Akceptuje sekundy oraz jednostkę czasu z sufiksem.

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

Domyślnie: 30s.

Zachowanie właściwości:
- obsługiwane jeśli type jest ustawione na "Webhook"
process_tags integer Przetwarzaj wartości właściwości JSON w odpowiedzi skryptu webhooka jako tagi. Tagi te są dodawane do wszystkich istniejących tagów problemu.

Możliwe wartości:
0 - (domyślnie) Ignoruj odpowiedź skryptu webhooka;
1 - Przetwarzaj odpowiedź skryptu webhooka jako tagi.

Zachowanie właściwości:
- obsługiwane jeśli type jest ustawione na "Webhook"
show_event_menu integer Uwzględnij wpis w menu zdarzeń, który prowadzi do niestandardowego adresu URL. Dodaje również właściwość urls do wyniku problem.get i event.get.

Możliwe wartości:
0 - (domyślnie) Nie uwzględniaj wpisu menu zdarzeń ani właściwości urls;
1 - Uwzględnij wpis menu zdarzeń i właściwość urls.

Zachowanie właściwości:
- obsługiwane jeśli type jest ustawione na "Webhook"
event_menu_url string Adres URL używany we wpisie menu zdarzeń oraz we właściwości urls zwracanej przez problem.get i event.get.

Zachowanie właściwości:
- obsługiwane jeśli show_event_menu jest ustawione na "Include event menu entry and urls property"
event_menu_name string Nazwa używana we wpisie menu zdarzeń oraz we właściwości urls zwracanej przez problem.get i event.get.

Zachowanie właściwości:
- obsługiwane jeśli show_event_menu jest ustawione na "Include event menu entry and urls property"
parameters array Parametry webhooka lub skryptu.

Zachowanie właściwości:
- obsługiwane jeśli type jest ustawione na "Webhook" lub "Script"
description text Opis typu medium.

Parametry webhooka

Parametry webhooka mają następujące właściwości.

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

Zachowanie właściwości:
- wymagane
value string Wartość parametru, obsługuje makra.
Obsługiwane makra są opisane na stronie Supported macros.

Parametry skryptu

Parametry skryptu mają następujące właściwości.

Właściwość Type Opis
sortorder integer Kolejność, w jakiej wartości parametrów będą przekazywane do skryptu jako argumenty wiersza poleceń, zaczynając od 0 jako pierwszego argumentu.

Zachowanie właściwości:
- wymagane
value string Wartość parametru, obsługuje makra.
Obsługiwane makra są opisane na stronie Supported macros.

Szablon wiadomości

Obiekt szablonu wiadomości definiuje szablon, który będzie używany jako domyślna wiadomość dla operacji akcji wysyłających powiadomienie. Ma on następujące właściwości.

Właściwość Type Opis
eventsource integer Źródło zdarzenia.

Możliwe wartości:
0 - Wyzwalacze;
1 - Wykrywanie;
2 - Autorejestracja;
3 - Wewnętrzne;
4 - Usługi.

Property behavior:
- required
recovery integer Tryb operacji.

Możliwe wartości:
0 - Operacje;
1 - Operacje odzyskiwania;
2 - Operacje aktualizacji.

Property behavior:
- required
subject string Temat wiadomości.
message string Treść wiadomości.