Szablony

Omówienie

Szablony są eksportowane wraz z wieloma powiązanymi obiektami i relacjami między obiektami.

Eksport szablonu zawiera:

  • Powiązane grupy szablonów
  • Powiązane grupy hostów (jeśli są używane w konfiguracji prototypu hosta)
  • Dane szablonu
  • Powiązania z innymi szablonami
  • Powiązania z grupami szablonów
  • Bezpośrednio powiązane pozycje
  • Bezpośrednio powiązane wyzwalacze
  • Bezpośrednio powiązane wykresy
  • Bezpośrednio powiązane pulpity
  • Bezpośrednio powiązane reguły wykrywania ze wszystkimi prototypami
  • Bezpośrednio powiązane scenariusze web
  • Mapy wartości

Eksportowanie

Aby wyeksportować szablony, wykonaj następujące czynności:

  1. Przejdź do Data collection > Templates.
  2. Zaznacz pola wyboru szablonów do wyeksportowania.
  3. Kliknij Export pod listą.

W zależności od wybranego formatu szablony są eksportowane do pliku lokalnego z domyślną nazwą:

  • zabbix_export_templates.yaml - w eksporcie YAML (domyślna opcja eksportu);
  • zabbix_export_templates.xml - w eksporcie XML;
  • zabbix_export_templates.json - w eksporcie JSON.

Importowanie

Aby zaimportować szablony, wykonaj następujące czynności:

  1. Przejdź do Data collection > Templates.
  2. Kliknij Import w prawym górnym rogu.
  3. Wybierz plik importu.
  4. Kliknij Import w prawym dolnym rogu formularza konfiguracji.

Jeśli zaznaczysz pole wyboru Advanced options, zostanie wyświetlona szczegółowa lista wszystkich elementów możliwych do zaimportowania - zaznacz lub odznacz każdą regułę importu zgodnie z potrzebami.

Jeśli klikniesz pole wyboru w wierszu All, wszystkie elementy poniżej zostaną zaznaczone/odznaczone.

Reguły importu:

Rule Description
Update existing Istniejące elementy zostaną zaktualizowane na podstawie danych z pliku importu. W przeciwnym razie nie zostaną zaktualizowane.
Create new Nowe elementy zostaną utworzone na podstawie danych z pliku importu. W przeciwnym razie nie zostaną utworzone.
Delete missing Istniejące elementy, których nie ma w pliku importu, zostaną usunięte. W przeciwnym razie nie zostaną usunięte.
Jeśli opcja Delete missing jest zaznaczona dla Template linkage, bieżące powiązania szablonów, których nie ma w pliku importu, zostaną odłączone. Encje (pozycje, wyzwalacze, wykresy itp.) odziedziczone z odłączonych szablonów nie zostaną usunięte (chyba że opcja Delete missing zostanie wybrana również dla każdej encji).

Jeśli szablony o tych samych nazwach już istnieją, podczas importu należy zaznaczyć opcje Delete missing, aby uzyskać czysty import. W ten sposób stare pozycje, które nie są już obecne w zaktualizowanym szablonie, zostaną usunięte (należy pamiętać, że oznacza to utratę historii tych starych pozycji).

Na następnym ekranie będzie można wyświetlić zawartość importowanego szablonu. Jeśli jest to nowy szablon, wszystkie elementy zostaną wyświetlone na zielono. W przypadku aktualizacji istniejącego szablonu nowe elementy szablonu zostaną wyróżnione na zielono; usunięte elementy szablonu zostaną wyróżnione na czerwono; elementy, które nie uległy zmianie, zostaną wyświetlone na szarym tle.

Menu po lewej stronie można wykorzystać do nawigacji po liście zmian. Sekcja Updated wyróżnia wszystkie zmiany wprowadzone w istniejących elementach szablonu. Sekcja Added zawiera listę nowych elementów szablonu. Elementy w każdej sekcji są pogrupowane według typu elementu; kliknij szarą strzałkę, aby rozwinąć lub zwinąć grupę elementów.

Przejrzyj zmiany w szablonie, a następnie kliknij Import, aby wykonać import szablonu. W frontend zostanie wyświetlony komunikat o powodzeniu lub niepowodzeniu importu.

Format eksportu

Gdy szablon jest eksportowany, Zabbix generuje uporządkowany format YAML, JSON lub XML. Eksport obejmuje elementy szablonu, takie jak metadane szablonu, pozycje, makra, wyzwalacze, pulpity i inne.

Każdy element pełni określoną funkcję i może zawierać elementy zagnieżdżone.

W kolejnych sekcjach opisano każdy element w formacie eksportu. W przykładach użyto szablonu Linux by Zabbix agent.

Wielokropek (...) oznacza elementy pominięte ze względu na zwięzłość. Uwaga (see table below) jest używana, gdy element jest wyjaśniony bardziej szczegółowo w późniejszych sekcjach.

Metadane szablonu

zabbix_export:
  version: '8.0'
  template_groups:
    - uuid: 846977d1dfed4968bc5f8bdb363285bc
      name: 'Templates/Operating systems'
  templates: (see table below)
  triggers: (see table below)
  graphs: (see table below)
Element Type Opis
version string (wymagane) Wersja eksportu.
template_groups (wymagane) Element główny dla grup szablonów.
uuid string (wymagane) Unikalny identyfikator tej grupy szablonów.
name string (wymagane) Nazwa grupy szablonów.
host_groups Element główny dla grup hostów używanych przez prototypy hostów.
uuid string (wymagane) Unikalny identyfikator tej grupy hostów.
name string (wymagane) Nazwa grupy hostów.
templates Element główny dla szablonów.
triggers Element główny dla elementów wyzwalaczy szablonu, które są takie same jak dla wyzwalaczy pozycji szablonu.
graphs Element główny dla elementów wykresów szablonu, które są takie same jak dla wykresów hosta.

Szablony

zabbix_export:
  (...)
  templates:
    - uuid: f8f7908280354f2abeed07dc788c3747
      template: 'Linux by Zabbix agent'
      name: 'Linux by Zabbix agent'
      description: |
        To jest oficjalny szablon Linux. Wymaga Zabbix agent 8.0 lub nowszego. (...)
      wizard_ready: 'YES'
      readme: |
        ## Omówienie

        To jest oficjalny szablon Linux. Wymaga Zabbix agent 8.0 lub nowszego. (...)
      vendor:
        name: Zabbix
        version: 8.0-2
      groups:
        - name: 'Templates/Operating systems'
      items: (see table below)
      discovery_rules: (see table below)
      tags:
        - tag: class
          value: os
        - tag: target
          value: linux
      macros:
        - macro: '{$AGENT.TIMEOUT}'
          value: 3m
          description: 'Limit czasu, po którym agent jest uznawany za niedostępny. Działa tylko dla agentów osiągalnych z serwer/proxy Zabbix (tryb pasywny).'
          config: (see table below)
        - macro: '{$CPU.UTIL.CRIT}'
          value: '90'
          description: 'Krytyczny próg użycia CPU wyrażony w %.'
          config: (see table below)
        (...)
      dashboards: (see table below)
      valuemaps: (see table below)
    (...)
Element Type Description
uuid string (wymagane) Unikalny identyfikator tego szablonu.
template string (wymagane) Unikalna nazwa szablonu.
name string Widoczna nazwa szablonu.
description text Opis szablonu.
wizard_ready text Określa, czy szablon jest dostępny do wyboru w Kreatorze hosta.
Możliwe wartości:1 NO (0, domyślnie), YES (1).
Zobacz też: Obiekt Template (wizard_ready).
readme text Instrukcje konfiguracji specyficzne dla szablonu, wyświetlane w Kreatorze hosta. Obsługuje formatowanie Markdown.
vendor Element główny dla dostawcy szablonu (obecny, jeśli wyeksportowany szablon zawiera dane dostawcy).
name string (wymagane) Nazwa dostawcy szablonu.
version string (wymagane) Wersja szablonu.
W przypadku szablonów dostarczanych standardowo wersja jest wyświetlana w następującej postaci: główna wersja Zabbix, separator ("-"), numer rewizji (zwiększany przy każdej nowej wersji szablonu i resetowany przy każdej głównej wersji Zabbix). Na przykład 7.0-0, 7.0-3, 8.0-0, 8.0-3.
templates Element główny dla powiązanych szablonów.
name string (wymagane) Nazwa szablonu.
groups Element główny dla grup szablonów.
name string (wymagane) Nazwa grupy szablonów.
items Element główny dla pozycji szablonu.
discovery_rules Element główny dla reguł niskopoziomowego wykrywania szablonu.
httptests Element główny dla scenariuszy web szablonu.
tags Element główny dla tagów szablonu.
tag string (wymagane) Nazwa tagu.
value string Wartość tagu.
macros Element główny dla makr użytkownika szablonu.
macro string (wymagane) Nazwa makra użytkownika.
type string Typ makra użytkownika.
Możliwe wartości:1 TEXT (0, domyślnie), SECRET_TEXT (1), VAULT (2).
Zobacz też: Obiekt User macro (type).
value string Wartość makra użytkownika.
description string Opis makra użytkownika.
config Element główny dla konfiguracji makra szablonu, odpowiedzialny za sposób wyświetlania makra w Kreatorze hosta.
dashboards Element główny dla dashboardów szablonu.
valuemaps Element główny dla map wartości szablonu.

Pozycje szablonu

zabbix_export:
  (...)
  templates:
    (...)
      items:
        - uuid: f94f9f4699e94c369e6c98b2a2f485ce
          name: 'Zabbix agent ping'
          key: agent.ping
          description: 'Agent zawsze zwraca dla tej pozycji wartość "1". Może być używany w połączeniu z `nodata()` do sprawdzania dostępności.'
          valuemap:
            name: 'Zabbix agent ping status'
          tags:
            - tag: component
              value: system
        (...)
        - uuid: 58818005e76d46dda14d6592f601ab00
          name: 'Number of installed packages'
          key: system.sw.packages.get
          delay: 1h
          preprocessing: (see table below)
          tags:
            - tag: component
              value: os
          triggers: (see table below)
        - uuid: 403cebed115441369e94d35d070ca7b8
          name: 'Memory utilization'
          type: DEPENDENT
          key: vm.memory.utilization
          value_type: FLOAT
          units: '%'
          description: 'Procent użytej pamięci jest obliczany jako `100-pavailable`.'
          preprocessing: (see table below)
          master_item:
            key: 'vm.memory.size[pavailable]'
          tags:
            - tag: component
              value: memory
          triggers: (see table below)
        (...)
Element Type Opis
uuid string (wymagane) Unikalny identyfikator tej pozycji.
name string (wymagane) Nazwa pozycji.
type string Typ pozycji.
Dopuszczalne wartości:1 ZABBIX_PASSIVE (0, domyślnie), TRAP (2), SIMPLE (3), INTERNAL (5), ZABBIX_ACTIVE (7), EXTERNAL (10), ODBC (11), IPMI (12), SSH (13), TELNET (14), CALCULATED (15), JMX (16), SNMP_TRAP (17), DEPENDENT (18), HTTP_AGENT (19), SNMP_AGENT (20), ITEM_TYPE_SCRIPT (21), ITEM_TYPE_BROWSER (22).
snmp_oid string (wymagane dla pozycji SNMP_AGENT) Identyfikator obiektu SNMP.
key string (wymagane) Klucz pozycji.
delay string Interwał aktualizacji pozycji.
Domyślnie: 1m. Wartość będzie zawsze równa 0 dla pozycji TRAP.
history string Okres czasu (z użyciem przyrostka czasu, makra użytkownika lub makra LLD), przez jaki dane historyczne mają być przechowywane.
Domyślnie: 31d.
trends string Okres czasu (z użyciem przyrostka czasu, makra użytkownika lub makra LLD), przez jaki dane trendów mają być przechowywane.
Domyślnie: 365d.
status string Status pozycji.
Dopuszczalne wartości:1 ENABLED (0, domyślnie), DISABLED (1).
value_type string Typ odebranej wartości.
Dopuszczalne wartości:1 FLOAT (0), CHAR (1), LOG (2), UNSIGNED (3, domyślnie), TEXT (4), BINARY (5), JSON (6).
allowed_hosts string Lista adresów IP hostów, oddzielonych przecinkami, które mogą wysyłać dane dla tej pozycji.
Obsługiwane dla pozycji TRAP i HTTP_AGENT.
units string Jednostki odebranej wartości (bps, B, itd.).
params text Dodatkowe parametry zależne od typu pozycji (wykonywany skrypt dla pozycji SSH i TELNET; zapytanie SQL dla pozycji ODBC; formuła dla pozycji CALCULATED; skrypt dla pozycji ITEM_TYPE_SCRIPT i ITEM_TYPE_BROWSER).
ipmi_sensor string Czujnik IPMI.
Obsługiwane dla pozycji IPMI.
authtype string Typ uwierzytelniania.
Obsługiwane dla pozycji SSH i HTTP_AGENT.
Dopuszczalne wartości dla pozycji SSH:1 PASSWORD (0, domyślnie), PUBLIC_KEY (1).
Dopuszczalne wartości dla pozycji HTTP_AGENT:1 NONE (0, domyślnie), BASIC (1), NTLM (2), Kerberos (3) lub Digest (4).
username string (wymagane dla pozycji SSH i TELNET) Nazwa użytkownika do uwierzytelniania.
Obsługiwane dla pozycji SIMPLE, ODBC, JMX i HTTP_AGENT.
W przypadku użycia dla pozycji JMX należy również określić password (patrz poniżej) albo pozostawić oba elementy puste.
password string (wymagane dla pozycji SSH i TELNET) Hasło do uwierzytelniania.
Obsługiwane dla pozycji SIMPLE, ODBC, JMX i HTTP_AGENT.
W przypadku użycia dla pozycji JMX należy również określić username (patrz powyżej) albo pozostawić oba elementy puste.
publickey string (wymagane dla pozycji SSH) Nazwa pliku klucza publicznego.
privatekey string (wymagane dla pozycji SSH) Nazwa pliku klucza prywatnego.
description text Opis pozycji.
inventory_link string Pole inwentarza hosta, które jest wypełniane przez pozycję.
Dopuszczalne wartości:1 NONE (0), ALIAS (4), itd. (obsługiwane pola: zobacz Host inventory).
valuemap Element nadrzędny map wartości pozycji.
name string (wymagane) Nazwa mapy wartości używanej dla pozycji.
logtimefmt string Format czasu w wpisach dziennika.
Obsługiwane dla pozycji typu wartości LOG.
preprocessing Element nadrzędny wstępnego przetwarzania wartości pozycji.
step Element nadrzędny kroków wstępnego przetwarzania wartości pozycji szablonu.
jmx_endpoint string Punkt końcowy JMX.
Obsługiwane dla pozycji JMX.
master_item (wymagane dla pozycji DEPENDENT) Element nadrzędny dla pozycji nadrzędnej pozycji zależnej.
key string (wymagane) Klucz pozycji nadrzędnej pozycji zależnej.
timeout string Limit czasu żądania odpytywania danych pozycji.
Obsługiwane dla listy typów pozycji Timeouts.
url string (wymagane dla pozycji HTTP_AGENT) Ciąg URL.
query_fields Element nadrzędny parametrów zapytania.
Obsługiwane dla pozycji HTTP_AGENT.
name string (wymagane dla pozycji HTTP_AGENT) Nazwa parametru zapytania.
value string Wartość parametru zapytania.
Obsługiwane dla pozycji HTTP_AGENT.
parameters Element nadrzędny parametrów zdefiniowanych przez użytkownika.
Obsługiwane dla pozycji ITEM_TYPE_SCRIPT i ITEM_TYPE_BROWSER.
name string (wymagane dla pozycji ITEM_TYPE_SCRIPT i ITEM_TYPE_BROWSER) Nazwa parametru zdefiniowanego przez użytkownika.
value string Wartość parametru zdefiniowanego przez użytkownika.
Obsługiwane dla pozycji ITEM_TYPE_SCRIPT i ITEM_TYPE_BROWSER.
posts string Dane treści żądania HTTP(S).
Obsługiwane dla pozycji HTTP_AGENT.
status_codes string Zakresy wymaganych kodów statusu HTTP, oddzielone przecinkami.
Obsługiwane dla pozycji HTTP_AGENT.
follow_redirects string Podążaj za przekierowaniami odpowiedzi podczas odpytywania danych.
Obsługiwane dla pozycji HTTP_AGENT.
Dopuszczalne wartości:1 NO (0), YES (1, domyślnie).
post_type string Typ treści danych POST.
Obsługiwane dla pozycji HTTP_AGENT.
Dopuszczalne wartości:1 RAW (0, domyślnie), JSON (2), XML (3).
http_proxy string Ciąg połączenia proxy HTTP(S).
Obsługiwane dla pozycji HTTP_AGENT.
headers Element nadrzędny nagłówków żądania HTTP(S).
Obsługiwane dla pozycji HTTP_AGENT.
name string (wymagane dla pozycji HTTP_AGENT) Nazwa nagłówka.
value string (wymagane dla pozycji HTTP_AGENT) Wartość nagłówka.
retrieve_mode string Jaka część odpowiedzi ma zostać zapisana.
Obsługiwane dla pozycji HTTP_AGENT.
Dopuszczalne wartości:1 BODY (0, domyślnie), HEADERS (1), BOTH (2).
request_method string Typ metody żądania.
Obsługiwane dla pozycji HTTP_AGENT.
Dopuszczalne wartości:1 GET (0, domyślnie), POST (1), PUT (2), HEAD (3).
output_format string Sposób przetwarzania odpowiedzi.
Obsługiwane dla pozycji HTTP_AGENT.
Dopuszczalne wartości:1 RAW (0, domyślnie), JSON (1).
allow_traps string Zezwól na wypełnianie wartości podobnie jak w pozycji trapper.
Obsługiwane dla pozycji HTTP_AGENT.
Dopuszczalne wartości:1 NO (0, domyślnie), YES (1).
ssl_cert_file string Ścieżka do publicznego pliku klucza SSL.
Obsługiwane dla pozycji HTTP_AGENT.
ssl_key_file string Ścieżka do prywatnego pliku klucza SSL.
Obsługiwane dla pozycji HTTP_AGENT.
ssl_key_password string Hasło do pliku klucza SSL.
Obsługiwane dla pozycji HTTP_AGENT.
verify_peer string Czy sprawdzać, czy certyfikat hosta jest autentyczny.
Obsługiwane dla pozycji HTTP_AGENT.
Dopuszczalne wartości:1 NO (0, domyślnie), YES (1).
verify_host string Czy sprawdzać, czy nazwa hosta dla połączenia odpowiada nazwie w certyfikacie hosta.
Obsługiwane dla pozycji HTTP_AGENT.
Dopuszczalne wartości:1 NO (0, domyślnie), YES (1).
tags Element nadrzędny tagów pozycji.
tag string (wymagane) Nazwa tagu.
value string Wartość tagu.
triggers Element nadrzędny wyzwalaczy pozycji szablonu.

Zobacz też: Obiekt Item (odwołaj się do odpowiedniej właściwości o pasującej nazwie).

Kroki przetwarzania wstępnego wartości pozycja szablonu
zabbix_export:
  (...)
  templates:
    (...)
      items:
        (...)
        - uuid: 58818005e76d46dda14d6592f601ab00
          (...)
          preprocessing:
            - type: JSONPATH
              parameters:
                - $.length()
            - type: DISCARD_UNCHANGED_HEARTBEAT
              parameters:
                - 12h
          (...)
Element Type Description
type string (wymagane) Typ kroku przetwarzania wstępnego wartości pozycji.
Dostępne wartości:1 MULTIPLIER (1), RTRIM (2), LTRIM (3), TRIM (4), REGEX (5), BOOL_TO_DECIMAL (6), OCTAL_TO_DECIMAL (7), HEX_TO_DECIMAL (8), SIMPLE_CHANGE (9, calculated: received value - previous value), CHANGE_PER_SECOND (10, calculated: (received value - previous value)/(time now - time of last check)), XMLPATH (11), JSONPATH (12), IN_RANGE (13), MATCHES_REGEX (14), NOT_MATCHES_REGEX (15), CHECK_JSON_ERROR (16), CHECK_XML_ERROR (17), CHECK_REGEX_ERROR (18), DISCARD_UNCHANGED (19), DISCARD_UNCHANGED_HEARTBEAT (20), JAVASCRIPT (21), PROMETHEUS_PATTERN (22), PROMETHEUS_TO_JSON (23), CSV_TO_JSON (24), STR_REPLACE (25), CHECK_NOT_SUPPORTED (26), XML_TO_JSON (27), SNMP_WALK_VALUE (28), SNMP_WALK_TO_JSON (29), SNMP_GET_VALUE (30).
parameters (wymagane) Element główny dla parametrów kroku przetwarzania wstępnego wartości pozycji.
parameter string Pojedynczy parametr kroku przetwarzania wstępnego wartości pozycji.
error_handler string Typ akcji używany w przypadku niepowodzenia kroku przetwarzania wstępnego.
Dostępne wartości:1 ORIGINAL_ERROR (0, domyślnie), DISCARD_VALUE (1), CUSTOM_VALUE (2), CUSTOM_ERROR (3).
error_handler_params string Parametry obsługi błędów.

Zobacz też: Obiekt przetwarzania wstępnego pozycji (odwołanie do odpowiedniej właściwości o zgodnej nazwie).

Wyzwalacze pozycji szablonu
zabbix_export:
  (...)
  templates:
    (...)
      items:
        (...)
        - uuid: 58818005e76d46dda14d6592f601ab00
          (...)
          triggers:
            - uuid: b950c306394f4b3c902060a8273cbcde
              expression: 'change(/Linux by Zabbix agent/system.sw.packages.get)<>0'
              name: 'Linux: Liczba zainstalowanych pakietów została zmieniona'
              priority: WARNING
              manual_close: 'YES'
              tags:
                - tag: scope
                  value: notice
        (...)
        - uuid: 403cebed115441369e94d35d070ca7b8
          (...)
          triggers:
            - uuid: cfd395b1cde74ef18a5e5f840bd5142a
              expression: 'min(/Linux by Zabbix agent/vm.memory.utilization,5m)>{$MEMORY.UTIL.MAX}'
              name: 'Linux: Wysokie wykorzystanie pamięci'
              event_name: 'Linux: Wysokie wykorzystanie pamięci (>{$MEMORY.UTIL.MAX}% przez 5m)'
              priority: AVERAGE
              description: 'Systemowi zaczyna brakować wolnej pamięci.'
              dependencies:
                - name: 'Linux: Brak dostępnej pamięci'
                  expression: 'max(/Linux by Zabbix agent/vm.memory.size[available],5m)<{$MEMORY.AVAILABLE.MIN} and last(/Linux by Zabbix agent/vm.memory.size[total])>0'
              tags:
                - tag: scope
                  value: capacity
                - tag: scope
                  value: performance
        (...)
Element Type Opis
uuid string (wymagane) Unikalny identyfikator tego wyzwalacza.
expression string (wymagane) Wyrażenie wyzwalacza.
recovery_mode string Podstawa generowania zdarzeń OK.
Możliwe wartości:1 EXPRESSION (0, domyślnie), RECOVERY_EXPRESSION (1), NONE (2).
recovery_expression string Wyrażenie odzyskiwania wyzwalacza.
correlation_mode string Tryb korelacji (bez korelacji zdarzeń lub korelacja zdarzeń według tagu).
Możliwe wartości:1 DISABLED (0, domyślnie), TAG_VALUE (1).
correlation_tag string Nazwa tagu używana do korelacji zdarzeń.
name string (wymagane) Nazwa wyzwalacza.
event_name string Nazwa zdarzenia.
opdata string Dane operacyjne.
url_name string Etykieta dla adresu URL powiązanego z wyzwalaczem.
url string Adres URL powiązany z wyzwalaczem.
status string Status wyzwalacza.
Możliwe wartości:1 ENABLED (0, domyślnie), DISABLED (1).
priority string Ważność wyzwalacza.
Możliwe wartości:1 NOT_CLASSIFIED (0, domyślnie), INFO (1), WARNING (2), AVERAGE (3), HIGH (4), DISASTER (5).
description text Opis wyzwalacza.
type string Typ generowania zdarzeń (pojedyncze zdarzenie problemu lub wiele zdarzeń problemu).
Możliwe wartości:1 SINGLE (0, domyślnie), MULTIPLE (1).
manual_close string Ręczne zamykanie zdarzeń problemu.
Możliwe wartości:1 NO (0, domyślnie), YES (1).
dependencies Element główny dla zależności.
name string (wymagane) Nazwa wyzwalacza zależności.
expression string (wymagane) Wyrażenie wyzwalacza zależności.
recovery_expression string Wyrażenie odzyskiwania wyzwalacza zależności.
tags Element główny dla tagów wyzwalacza.
tag string (wymagane) Nazwa tagu.
value string Wartość tagu.

Zobacz też: Trigger object (odwołaj się do odpowiedniej właściwości o pasującej nazwie).

Reguły wykrywania niskiego poziomu szablonu

zabbix_export:
  (...)
  templates:
    (...)
      discovery_rules:
        - uuid: acfdea9c46ef48c68e6636f43b8f96a2
          name: 'Network interface discovery'
          key: net.if.discovery
          delay: 1h
          filter: (see table below)
          description: 'The discovery of network interfaces.'
          item_prototypes: (see table below)
          trigger_prototypes: (see table below)
          graph_prototypes: (see table below)
        (...)

Większość elementów reguły wykrywania niskiego poziomu szablonu jest taka sama jak w przypadku pozycji szablonu. Poniższa tabela opisuje te elementy, które różnią się od pozycji szablonu.

Element Type Description
type string Typ pozycji.
Możliwe wartości:1 ZABBIX_PASSIVE (0, domyślnie), TRAP (2), SIMPLE (3), INTERNAL (5), ZABBIX_ACTIVE (7), EXTERNAL (10), ODBC (11), IPMI (12), SSH (13), TELNET (14), JMX (16), DEPENDENT (18), HTTP_AGENT (19), SNMP_AGENT (20), ITEM_TYPE_SCRIPT (21), ITEM_TYPE_BROWSER (22).
key string (wymagane) Klucz reguły wykrywania niskiego poziomu.
filter Element główny dla filtrów reguły wykrywania niskiego poziomu szablonu.
lifetime string Okres czasu (w sekundach, z przyrostkiem czasu lub makrem użytkownika), po którym zasoby, które nie są już wykrywane, zostaną usunięte.
Domyślnie: 7d.
lifetime_type string Scenariusz usuwania utraconych zasobów LLD.
Możliwe wartości: DELETE_NEVER, DELETE_IMMEDIATELY, DELETE_AFTER.
enabled_lifetime string Okres czasu (w sekundach, z przyrostkiem czasu lub makrem użytkownika), po którym zasoby, które nie są już wykrywane, zostaną wyłączone.
enabled_lifetime_type string Scenariusz wyłączania utraconych zasobów LLD.
Możliwe wartości: DISABLE_NEVER, DISABLE_IMMEDIATELY, DISABLE_AFTER.
item_prototypes Element główny dla elementów prototypów pozycji szablonu, które są takie same jak w przypadku pozycji szablonu.
trigger_prototypes Element główny dla elementów prototypów wyzwalaczy szablonu, które są takie same jak w przypadku wyzwalaczy pozycji szablonu.
graph_prototypes Element główny dla elementów prototypów wykresów szablonu, które są takie same jak w przypadku wykresów hosta.
host_prototypes Element główny dla elementów prototypów hosta szablonu, które są takie same jak w przypadku hostów.
parent_discovery_rule Element główny dla nadrzędnej reguły wykrywania niskiego poziomu (lub prototypu reguły) prototypu reguły wykrywania niskiego poziomu. Ta właściwość oznacza, że jest to prototyp reguły LLD, bezpośredni element podrzędny wskazanej reguły/prototypu reguły.
key string (wymagane) Klucz nadrzędnej reguły wykrywania niskiego poziomu (lub prototypu reguły).
master_item string (wymagane dla reguł DEPENDENT) Element główny dla elementu nadrzędnego reguły zależnej.
lld_macro_paths Element główny dla ścieżek makr reguły wykrywania niskiego poziomu.
lld_macro string (wymagane) Nazwa makra reguły wykrywania niskiego poziomu.
path string (wymagane) Selektor wartości, która zostanie przypisana do odpowiedniego makra.
preprocessing Element główny dla wstępnego przetwarzania wartości reguły wykrywania niskiego poziomu.
step Element główny dla elementów kroków wstępnego przetwarzania wartości reguły wykrywania niskiego poziomu, które są takie same jak w przypadku kroków wstępnego przetwarzania wartości pozycji szablonu, z wyjątkiem mniejszej liczby możliwych wartości. Zobacz też: obiekt wstępnego przetwarzania reguły LLD.
overrides Element główny dla reguł nadpisywania reguły wykrywania niskiego poziomu.
name string (wymagane) Unikalna nazwa nadpisania.
step string (wymagane) Unikalny numer kolejności nadpisania.
stop string Zatrzymaj przetwarzanie kolejnych nadpisań, jeśli pasuje.
filter Element główny dla elementów filtra reguły nadpisywania reguły wykrywania niskiego poziomu szablonu, które są takie same jak w przypadku filtrów reguły wykrywania niskiego poziomu szablonu.
operations Element główny dla operacji nadpisywania reguły wykrywania niskiego poziomu szablonu.

Zobacz też: obiekt reguły LLD (odwołaj się do odpowiedniej właściwości o zgodnej nazwie).

Filtry reguły wykrywania niskiego poziomu szablonu
zabbix_export:
  (...)
  templates:
    (...)
      discovery_rules:
        - uuid: acfdea9c46ef48c68e6636f43b8f96a2
          (...)
          filter:
            evaltype: AND
            conditions:
              - macro: '{#IFNAME}'
                value: '{$NET.IF.IFNAME.MATCHES}'
              - macro: '{#IFNAME}'
                value: '{$NET.IF.IFNAME.NOT_MATCHES}'
                operator: NOT_MATCHES_REGEX
          (...)
        - uuid: 2bbdc79f082d4c618e01bec625e9c90a
          (...)
          filter:
            evaltype: AND
            conditions:
              - macro: '{#DEVNAME}'
                value: '{$VFS.DEV.DEVNAME.MATCHES}'
              - macro: '{#DEVNAME}'
                value: '{$VFS.DEV.DEVNAME.NOT_MATCHES}'
                operator: NOT_MATCHES_REGEX
              - macro: '{#DEVTYPE}'
                value: disk
          (...)
Element Typ Opis
evaltype string Zastępuje metodę oceny warunków filtra.
Dostępne wartości:1 AND_OR (0, domyślnie), AND (1), OR (2), FORMULA (3).
formula string Niestandardowa formuła obliczeniowa dla warunków filtra.
conditions Element główny dla warunków filtra.
macro string (wymagane) Nazwa makra wykrywania niskiego poziomu, na którym ma zostać wykonane sprawdzenie.
value string Wartość do porównania.
operator string Operator warunku.
Dostępne wartości:1 MATCHES_REGEX (8, domyślnie), NOT_MATCHES_REGEX (9).
formulaid string (wymagane) Dowolny unikalny identyfikator używany do odwołania się do warunku z niestandardowego wyrażenia. Może zawierać wyłącznie wielkie litery. Identyfikator musi zostać zdefiniowany przez użytkownika podczas modyfikowania warunków filtra, ale przy kolejnym pobraniu zostanie wygenerowany ponownie.

Zobacz także: Obiekt filtra reguły LLD (odwołanie do odpowiedniej właściwości o zgodnej nazwie).

Operacje nadpisania reguły wykrywania niskiego poziomu szablonu
Element Type Description
operationobject string Obiekt, do którego jest stosowana operacja.
Możliwe wartości:1 ITEM_PROTOTYPE (0), TRIGGER_PROTOTYPE (1), GRAPH_PROTOTYPE (2), HOST_PROTOTYPE (3).
operator string Operator warunku nadpisania.
Możliwe wartości:1 EQUAL (1), NOT_EQUAL (2), LIKE (3), NOT_LIKE (4), REGEXP (5), NOT_REGEXP (6).
value string Wyrażenie regularne lub ciąg znaków dla operatora warunku nadpisania.
status string Status obiektu po operacji nadpisania.
discover string Czy obiekt jest dodawany w wyniku wykrycia.
delay string Interwał aktualizacji ustawiony dla prototypu pozycji po operacji nadpisania.
history string Okres przechowywania historii ustawiony dla prototypu pozycji po operacji nadpisania.
trends string Okres przechowywania trendów ustawiony dla prototypu pozycji po operacji nadpisania.
severity string Poziom ważności prototypu wyzwalacza ustawiony po operacji nadpisania.
tags Element główny dla tagów ustawionych dla obiektu po operacji nadpisania.
tag string (wymagane) Nazwa tagu.
value string Wartość tagu.
templates Element główny dla szablonów powiązanych z prototypem hosta po operacji nadpisania.
name string (wymagane) Nazwa szablonu.
inventory_mode string Tryb inwentarza prototypu hosta ustawiony po operacji nadpisania.

Zobacz też: Obiekt operacji nadpisania reguły LLD (odwołaj się do odpowiedniej właściwości o pasującej nazwie).

Szablon scenariuszy webowych

Element Type Description
uuid string (wymagane) Unikalny identyfikator tego scenariusza webowego.
name string (wymagane) Nazwa scenariusza webowego.
delay string Częstotliwość (w sekundach, przyrostek czasu lub makro użytkownika) wykonywania scenariusza webowego.
Domyślnie: 1m.
attempts integer Liczba prób wykonania kroków scenariusza webowego.
Możliwe wartości:1 1-10 (domyślnie: 1).
agent string Agent klienta. Zabbix będzie podszywać się pod wybraną przeglądarkę.
Jest to przydatne, gdy witryna zwraca różną zawartość dla różnych przeglądarek.
Domyślnie: Zabbix.
http_proxy string Proxy używany przez scenariusz webowy, podawany jako: http://[username[:password]@]proxy.example.com[:port]
variables Element główny dla zmiennych scenariusza webowego, które mogą być używane w krokach scenariusza.
name string (wymagane) Nazwa zmiennej.
value text (wymagane) Wartość zmiennej.
headers Element główny dla nagłówków HTTP wysyłanych podczas wykonywania żądania.
Nagłówki powinny być wymienione przy użyciu tej samej składni, w jakiej występowałyby w protokole HTTP.
name string (wymagane) Nazwa nagłówka.
value text (wymagane) Wartość nagłówka.
status string Status scenariusza webowego.
Możliwe wartości:1 ENABLED (0, domyślnie), DISABLED (1).
authentication string Metoda uwierzytelniania.
Możliwe wartości:1 NONE (0, domyślnie), BASIC (1), NTLM (2), Kerberos (3) lub Digest (4).
http_user string Nazwa użytkownika używana do uwierzytelniania BASIC (HTTP), NTLM, Kerberos lub Digest.
http_password string Hasło używane do uwierzytelniania BASIC (HTTP), NTLM, Kerberos lub Digest.
verify_peer string Sprawdź certyfikat SSL serwera webowego.
Możliwe wartości:1 NO (0, domyślnie), YES (1).
verify_host string Sprawdź, czy pole Common Name lub pole Subject Alternate Name certyfikatu serwera webowego jest zgodne.
Możliwe wartości:1 NO (0, domyślnie), YES (1).
ssl_cert_file string Nazwa pliku certyfikatu SSL używanego do uwierzytelniania klienta (musi być w formacie PEM).
ssl_key_file string Nazwa pliku prywatnego klucza SSL używanego do uwierzytelniania klienta (musi być w formacie PEM).
ssl_key_password string Hasło pliku prywatnego klucza SSL.
steps (wymagane) Element główny dla kroków scenariusza webowego szablonu.
tags Element główny dla tagów scenariusza webowego.
tag string (wymagane) Nazwa tagu.
value string Wartość tagu.

Zobacz także: Obiekt scenariusza webowego (odwołaj się do odpowiedniej właściwości o pasującej nazwie).

Kroki scenariusza web szablonu
Element Type Description
name string (required) Nazwa kroku scenariusza web.
url string (required) URL do monitorowania.
query_fields Element główny dla parametrów zapytania (tablica pól HTTP, które mają zostać dodane do URL podczas wykonywania żądania).
name string (required) Nazwa parametru zapytania.
value string Wartość parametru zapytania.
posts Element główny dla zmiennych HTTP POST (ciąg znaków (surowe dane POST) lub tablica pól HTTP (dane pól formularza)).
name string (required) Nazwa pola POST.
value string (required) Wartość pola POST.
variables Element główny zmiennych na poziomie kroku (makr), które powinny zostać zastosowane po tym kroku.
Jeśli wartość zmiennej ma prefiks 'regex:', jej wartość jest wyodrębniana z danych zwróconych przez ten krok zgodnie z wyrażeniem regularnym następującym po prefiksie 'regex:'
name string (required) Nazwa zmiennej.
value text (required) Wartość zmiennej.
headers Element główny nagłówków HTTP, które mają zostać wysłane podczas wykonywania żądania.
name string (required) Nazwa nagłówka.
value text (required) Wartość nagłówka.
follow_redirects string Podążaj za przekierowaniami HTTP.
Możliwe wartości:1 NO (0), YES (1, domyślnie).
retrieve_mode string Tryb pobierania odpowiedzi HTTP.
Możliwe wartości:1 BODY (0, domyślnie), HEADERS (1), BOTH (2).
timeout string Limit czasu (w sekundach, time suffix lub user macro) wykonania kroku.
Domyślnie: 15s.
required string Tekst, który musi być obecny w odpowiedzi (ignorowany, jeśli pusty).
status_codes string Lista kodów statusu HTTP rozdzielona przecinkami, które są akceptowane (np. 200-201,210-299; ignorowane, jeśli puste).

Zobacz także: Obiekt kroku scenariusza web (odwołaj się do odpowiedniej właściwości o pasującej nazwie).

Konfiguracja makra szablonu

zabbix_export:
  (...)
  templates:
    - uuid: f8f7908280354f2abeed07dc788c3747
      (...)
      macros:
        - macro: '{$AGENT.TIMEOUT}'
          (...)
          config:
            type: TEXT
            priority: '1'
            label: 'Sekundy od ostatniego wykrycia agenta Zabbix'
            description: 'Limit czasu, po którym agent jest uznawany za niedostępny.'
        - macro: '{$CPU.UTIL.CRIT}'
          (...)
          config:
            type: TEXT
            priority: '2'
            section_name: Thresholds
            label: 'Próg wykorzystania CPU wyrażony'
            description: 'Krytyczny próg wykorzystania CPU wyrażony w %. W zakresie od 0 do 100 włącznie.'
            regex: '^-?([0-9]+|(([0-9]+)\.([0-9]+)))$'
        (...)
        - macro: '{$IFCONTROL}'
          (...)
          config:
            type: CHECKBOX
            priority: '19'
            label: 'Kontrola interfejsów'
            description: 'Wyzwól wyzwalacz, gdy status operacyjny interfejsu zmieni się na "Link down".'
            options:
              - checked: '1'
                unchecked: '0'
        (...)
Element Type Description
type string (wymagane) Typ pola wejściowego makra.
Możliwe wartości:1 NOCONF (0), TEXT (1), LIST (2), CHECKBOX (3).
priority string Pozycja makra na liście makr.
section_name string Etykieta zwijanej sekcji, w której grupowane jest makro.
label string (wymagane dla makr TEXT, LIST, CHECKBOX) Etykieta makra.
description text Tekst pomocy dla makra. Obsługuje formatowanie Markdown.
required string Oznacza makro jako obowiązkowe.
Możliwe wartości:1 NO (0), YES (1).
Obsługiwane dla makr TEXT i LIST.
regex string Wyrażenie regularne do walidacji danych wprowadzonych przez użytkownika w polu tekstowym.
Obsługiwane dla makr TEXT.
options Element główny dla pozycji LIST lub wartości CHECKBOX.
value string (wymagane dla makr LIST) Wartość pozycji LIST.
text string (wymagane dla makr LIST) Tekst pozycji LIST.
checked string (wymagane dla makr CHECKBOX) Wartość reprezentująca stan zaznaczony.
Możliwe wartości:1 0 (false), 1 (true).
Obsługiwane dla makr CHECKBOX.
unchecked string (wymagane dla makr CHECKBOX) Wartość reprezentująca stan niezaznaczony.
Możliwe wartości:1 0 (false), 1 (true).
Obsługiwane dla makr CHECKBOX.

Zobacz także: Obiekt konfiguracji makra (odwołaj się do odpowiedniej właściwości o pasującej nazwie).

Pulpity szablonu

zabbix_export:
  (...)
  templates:
    (...)
      dashboards:
        - uuid: c689ad3115fd46a4b927d1f70ee2e5a4
          name: Filesystems
          pages:
            - name: Overview
              widgets: (see table below)
        (...)
Element Type Opis
uuid string (wymagane) Unikalny identyfikator tego pulpitu.
name string (wymagane) Nazwa pulpitu szablonu.
display period integer Okres wyświetlania stron pulpitu.
auto_start string Automatyczne uruchamianie pokazu slajdów.
Possible values:1 NO (0), YES (1, default).
pages Element główny dla stron pulpitu szablonu.
name string Nazwa strony.
display period integer Okres wyświetlania strony.
sortorder integer Kolejność sortowania strony.
widgets Element główny dla widżetów pulpitu szablonu.

Zobacz także: Obiekt pulpitu szablonu (odwołanie do odpowiedniej właściwości o pasującej nazwie).

Widżety pulpitu szablonu
zabbix_export:
  (...)
  templates:
    (...)
      dashboards:
        - uuid: c689ad3115fd46a4b927d1f70ee2e5a4
          name: Filesystems
          pages:
            - name: Overview
              widgets:
                - type: graphprototype
                  width: '72'
                  height: '5'
                  fields:
                    - type: INTEGER
                      name: columns
                      value: '3'
                    - type: GRAPH_PROTOTYPE
                      name: graphid.0
                      value:
                        host: 'Linux by Zabbix agent'
                        name: 'FS [{#FSTYPE}({#FSNAME})]: Wykres wykorzystania przestrzeni (względem całości)'
                    - type: STRING
                      name: reference
                      value: AAAEB
                - type: graphprototype
                  'y': '5'
                  width: '72'
                  height: '5'
                  fields:
                    - type: INTEGER
                      name: columns
                      value: '1'
                    - type: GRAPH_PROTOTYPE
                      name: graphid.0
                      value:
                        host: 'Linux by Zabbix agent'
                        name: 'FS [{#FSTYPE}({#FSNAME})]: Wykres użycia przestrzeni, w % (względem maksymalnie dostępnej)'
                    - type: STRING
                      name: reference
                      value: AAAEC
        (...)
Element Type Opis
type string (wymagane) Typ widżetu.
name string Nazwa widżetu.
x integer Pozycja pozioma od lewej strony pulpitu szablonu.
Możliwe wartości:1 0-71.
y integer Pozycja pionowa od górnej strony pulpitu szablonu.
Możliwe wartości:1 0-63.
width integer Szerokość widżetu.
Możliwe wartości:1 1-72.
height integer Wysokość widżetu.
Możliwe wartości:1 1-64.
hide_header string Ukryj nagłówek widżetu.
Możliwe wartości:1 NO (0, domyślnie), YES (1).
fields Element główny dla pól widżetu pulpitu szablonu.
type string (wymagane) Typ pola widżetu.
Możliwe wartości:1 INTEGER (0), STRING (1), ITEM (4), ITEM_PROTOTYPE (5), GRAPH (6), GRAPH_PROTOTYPE (7), MAP (8), SERVICE (9), SLA (10), USER (11), ACTION (12), MEDIA_TYPE (13).
name string (wymagane) Nazwa pola widżetu.
value mixed (wymagane) Wartość pola widżetu, zależnie od typu pola.

Zobacz także: Obiekt widżetu pulpitu szablonu (odwołaj się do odpowiedniej właściwości o pasującej nazwie).

Mapy wartości szablonu

zabbix_export:
  (...)
  templates:
    (...)
      valuemaps:
        - uuid: 8c048c6cca8248f2860c208e8db0f59e
          name: ifOperStatus
          mappings:
            - value: '0'
              newvalue: unknown
            - value: '1'
              newvalue: notpresent
            - value: '2'
              newvalue: down
            - value: '3'
              newvalue: lowerlayerdown
            - value: '4'
              newvalue: testing
            - value: '5'
              newvalue: dormant
            - value: '6'
              newvalue: up
        (...)
Element Type Opis
uuid string (wymagane) Unikalny identyfikator tej mapy wartości.
name string (wymagane) Nazwa mapy wartości.
mapping Element główny dla mapowań.
type string Typ dopasowania mapowania.
Możliwe wartości:1 EQUAL (0, domyślnie), GREATER_OR_EQUAL (2), LESS_OR_EQUAL (3), IN_RANGE (4), REGEXP (5), DEFAULT (6).
value string Wartość oryginalna.
newvalue string (wymagane) Wartość, na którą mapowana jest wartość oryginalna.

Zobacz także: Obiekt mapy wartości (odwołanie do odpowiedniej właściwości o pasującej nazwie).

Przypisy

1 Wartości całkowite API w nawiasach, na przykład ENABLED (0), są podane wyłącznie jako informacja pomocnicza. Więcej informacji można znaleźć na powiązanej stronie obiektu API w wpisie tabeli lub na końcu każdej sekcji.