Obiekt Akcji

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

Akcja

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

Właściwość Typ Opis
actionid ID ID akcji.

Zachowanie właściwości:
- tylko do odczytu
- wymagana dla operacji aktualizacji
esc_period string Domyślny czas trwania kroku operacji. Musi wynosić co najmniej 60 sekund. Akceptuje liczbę sekund (np. 60, 300), wartość z przyrostkiem czasu (np. 30s, 1m, 2h) lub makro użytkownika.

Zachowanie właściwości:
- obsługiwana, jeśli eventsource jest ustawione na „zdarzenie utworzone przez wyzwalacz”, „zdarzenie wewnętrzne” lub „zdarzenie utworzone podczas aktualizacji stanu usługi”
eventsource integer Typ zdarzeń, które będzie obsługiwać akcja.

Lista obsługiwanych typów zdarzeń znajduje się w opisie właściwości source zdarzenia.

Zachowanie właściwości:
- stała
- wymagana dla operacji tworzenia
name string Nazwa akcji.

Zachowanie właściwości:
- wymagana dla operacji tworzenia
status integer Określa, czy akcja jest włączona, czy wyłączona.

Możliwe wartości:
0 - (domyślnie) włączona;
1 - wyłączona.
pause_symptoms integer Określa, czy wstrzymać eskalację, jeśli zdarzenie jest zdarzeniem objawowym.

Możliwe wartości:
0 - Nie wstrzymuj eskalacji w przypadku problemów objawowych;
1 - (domyślnie) Wstrzymuj eskalację w przypadku problemów objawowych.

Zachowanie właściwości:
- obsługiwana, jeśli eventsource jest ustawione na „zdarzenie utworzone przez wyzwalacz”
pause_suppressed integer Określa, czy wstrzymać eskalację podczas okresów konserwacji.

Możliwe wartości:
0 - Nie wstrzymuj eskalacji;
1 - (domyślnie) Wstrzymuj eskalację.

Zachowanie właściwości:
- obsługiwana, jeśli eventsource jest ustawione na „zdarzenie utworzone przez wyzwalacz”
notify_if_canceled integer Określa, czy wysyłać powiadomienie po anulowaniu eskalacji.

Możliwe wartości:
0 - Nie wysyłaj powiadomienia po anulowaniu eskalacji;
1 - (domyślnie) Wysyłaj powiadomienie po anulowaniu eskalacji.

Zachowanie właściwości:
- obsługiwana, jeśli eventsource jest ustawione na „zdarzenie utworzone przez wyzwalacz”

Operacja akcji

Obiekt operacji akcji definiuje operację, która zostanie wykonana po wykonaniu akcji. Ma on następujące właściwości.

Property Type Description
operationtype integer Typ operacji.

Możliwe wartości:
0 - wysłanie wiadomości;
1 - skrypt globalny;
2 - dodanie hosta;
3 - usunięcie hosta;
4 - dodanie do grupy hostów;
5 - usunięcie z grupy hostów;
6 - powiązanie szablonu;
7 - odłączenie szablonu;
8 - włączenie hosta;
9 - wyłączenie hosta;
10 - ustawienie trybu inwentaryzacji hosta;
13 - dodanie znaczników hosta;
14 - usunięcie znaczników hosta.

Możliwe wartości, jeśli właściwość eventsource obiektu Action jest ustawiona na „zdarzenie utworzone przez wyzwalacz” lub „zdarzenie utworzone podczas aktualizacji stanu usługi”:
0 - „wysłanie wiadomości”;
1 - „skrypt globalny”.

Możliwe wartości, jeśli właściwość eventsource obiektu Action jest ustawiona na „zdarzenie wewnętrzne”:
0 - „wysłanie wiadomości”.

Zachowanie właściwości:
- required
esc_period string Czas trwania kroku eskalacji w sekundach. Musi być większy niż 60 sekund. Akceptuje liczbę sekund (np. 60, 300), wartość z przyrostkiem czasu (np. 30s, 1m, 2h) lub makro użytkownika. Jeśli ustawiono wartość 0 lub 0s, zostanie użyty domyślny okres eskalacji akcji.

Wartość domyślna: 0s.

Zachowanie właściwości:
- supported jeśli właściwość eventsource obiektu Action jest ustawiona na „zdarzenie utworzone przez wyzwalacz”, „zdarzenie wewnętrzne” lub „zdarzenie utworzone podczas aktualizacji stanu usługi”
esc_step_from integer Krok, od którego należy rozpocząć eskalację.

Wartość domyślna: 1.

Zachowanie właściwości:
- supported jeśli właściwość eventsource obiektu Action jest ustawiona na „zdarzenie utworzone przez wyzwalacz”, „zdarzenie wewnętrzne” lub „zdarzenie utworzone podczas aktualizacji stanu usługi”
esc_step_to integer Krok, na którym należy zakończyć eskalację.

Wartość domyślna: 1.

Zachowanie właściwości:
- supported jeśli właściwość eventsource obiektu Action jest ustawiona na „zdarzenie utworzone przez wyzwalacz”, „zdarzenie wewnętrzne” lub „zdarzenie utworzone podczas aktualizacji stanu usługi”
evaltype integer Metoda oceny warunków operacji.

Możliwe wartości:
0 - (default) And/Or;
1 - And;
2 - Or.
opcommand object Skrypt globalny do wykonania.

Skrypt globalny musi mieć zdefiniowaną właściwość scriptid.

Zachowanie właściwości:
- required jeśli operationtype jest ustawione na „skrypt globalny”
opcommand_grp array Grupy hostów, na których należy uruchomić skrypty globalne.

Grupy hostów muszą mieć zdefiniowaną właściwość groupid.

Zachowanie właściwości:
- required jeśli operationtype jest ustawione na „skrypt globalny”, a opcommand_hst nie jest ustawione
opcommand_hst array Host, na którym należy uruchomić skrypty globalne.

Hosty muszą mieć zdefiniowaną właściwość hostid.

Zachowanie właściwości:
- required jeśli operationtype jest ustawione na „skrypt globalny”, a opcommand_grp nie jest ustawione
opconditions array Warunki operacji używane w akcjach wyzwalaczy.

Obiekt warunku operacji jest szczegółowo opisany poniżej.
opgroup array Grupy hostów, do których należy dodać hosty.

Grupy hostów muszą mieć zdefiniowaną właściwość groupid.

Zachowanie właściwości:
- required jeśli operationtype jest ustawione na „dodanie do grupy hostów” lub „usunięcie z grupy hostów”
opmessage object Obiekt zawierający dane wiadomości wysyłanej przez operację.

Obiekt wiadomości operacji jest szczegółowo opisany poniżej.

Zachowanie właściwości:
- required jeśli operationtype jest ustawione na „wysłanie wiadomości”
opmessage_grp array Grupy użytkowników, do których należy wysłać wiadomości.

Grupy użytkowników muszą mieć zdefiniowaną właściwość usrgrpid.

Zachowanie właściwości:
- required jeśli operationtype jest ustawione na „wysłanie wiadomości”, a opmessage_usr nie jest ustawione
opmessage_usr array Użytkownicy, do których należy wysłać wiadomości.

Użytkownicy muszą mieć zdefiniowaną właściwość userid.

Zachowanie właściwości:
- required jeśli operationtype jest ustawione na „wysłanie wiadomości”, a opmessage_grp nie jest ustawione
optemplate array Szablony, które należy powiązać z hostami.

Szablony muszą mieć zdefiniowaną właściwość templateid.

Zachowanie właściwości:
- required jeśli operationtype jest ustawione na „powiązanie szablonu” lub „odłączenie szablonu”
opinventory object Tryb inwentaryzacji ustawiany dla hosta.

Inwentaryzacja musi mieć zdefiniowaną właściwość inventory_mode.

Zachowanie właściwości:
- required jeśli operationtype jest ustawione na „ustawienie trybu inwentaryzacji hosta”
optag array Znaczniki hosta do dodania lub usunięcia.

Znaczniki muszą mieć zdefiniowaną właściwość tag.
Właściwość value jest opcjonalna.

Zachowanie właściwości:
- supported jeśli operationtype jest ustawione na „dodanie znaczników hosta” lub „usunięcie znaczników hosta”.

Wiadomość operacji akcji

Obiekt wiadomości operacji zawiera dane o wiadomości, która zostanie wysłana przez operację. Ma następujące właściwości.

Właściwość Type Opis
default_msg integer Czy użyć domyślnego tekstu i tematu wiadomości akcji.

Możliwe wartości:
0 - użyj danych z operacji;
1 - (domyślnie) użyj danych z typu nośnika.
mediatypeid ID ID typu nośnika, który zostanie użyty do wysłania wiadomości.

Zachowanie właściwości:
- obsługiwane, jeśli operationtype obiektu Action operation object, Action recovery operation object lub Action update operation object jest ustawione na „send message”, albo jeśli operationtype obiektu Action update operation object jest ustawione na „notify all involved”
message string Tekst wiadomości operacji.

Zachowanie właściwości:
- obsługiwane, jeśli default_msg jest ustawione na „use the data from the operation”
subject string Temat wiadomości operacji.

Zachowanie właściwości:
- obsługiwane, jeśli default_msg jest ustawione na „use the data from the operation”

Warunek operacji akcji

Obiekt warunku operacji akcji definiuje warunek, który musi zostać spełniony, aby wykonać bieżącą operację. Ma następujące właściwości.

Property Type Description
conditiontype integer Typ warunku.

Możliwe wartości:
14 - zdarzenie potwierdzone.

Zachowanie właściwości:
- wymagane
value string Wartość do porównania.

Zachowanie właściwości:
- wymagane
operator integer Operator warunku.

Możliwe wartości:
0 - (domyślnie) =

Dla każdego typu warunku operacji obsługiwane są następujące operatory i wartości.

Condition Condition name Supported operators Expected value
14 Zdarzenie potwierdzone = Czy zdarzenie jest potwierdzone.

Możliwe wartości:
0 - niepotwierdzone;
1 - potwierdzone.

Operacja odzyskiwania akcji

Obiekt operacji odzyskiwania akcji definiuje operację, która zostanie wykonana po rozwiązaniu problemu. Operacje odzyskiwania są możliwe tylko dla akcji wyzwalacza, wewnętrznych i usług. Ma następujące właściwości.

Właściwość Typ Opis
operationtype integer Typ operacji.

Możliwe wartości, jeśli eventsource obiektu Action object jest ustawione na „zdarzenie utworzone przez wyzwalacz” lub „zdarzenie utworzone przy aktualizacji stanu usługi”:
0 - wyślij wiadomość;
1 - skrypt globalny;
11 - powiadom wszystkich zaangażowanych.

Możliwe wartości, jeśli eventsource obiektu Action object jest ustawione na „zdarzenie wewnętrzne”:
0 - wyślij wiadomość;
11 - powiadom wszystkich zaangażowanych.

Zachowanie właściwości:
- wymagane
opcommand object Skrypt globalny do wykonania.

Skrypt globalny musi mieć zdefiniowaną właściwość scriptid.

Zachowanie właściwości:
- wymagane, jeśli operationtype jest ustawione na „skrypt globalny”
opcommand_grp array Grupy hostów, na których mają być uruchamiane skrypty globalne.

Grupy hostów muszą mieć zdefiniowaną właściwość groupid.

Zachowanie właściwości:
- wymagane, jeśli eventsource obiektu Action object jest ustawione na „zdarzenie utworzone przez wyzwalacz”, a operationtype jest ustawione na „skrypt globalny”, i opcommand_hst nie jest ustawione
opcommand_hst array Host, na którym mają być uruchamiane skrypty globalne.

Hosty muszą mieć zdefiniowaną właściwość hostid.

Zachowanie właściwości:
- wymagane, jeśli eventsource obiektu Action object jest ustawione na „zdarzenie utworzone przez wyzwalacz”, a operationtype jest ustawione na „skrypt globalny”, i opcommand_grp nie jest ustawione
opmessage object Obiekt zawierający dane o wiadomości wysyłanej przez operację odzyskiwania.

Obiekt wiadomości operacji jest opisany szczegółowo powyżej.

Zachowanie właściwości:
- wymagane, jeśli operationtype jest ustawione na „wyślij wiadomość”
opmessage_grp array Grupy użytkowników, do których mają być wysyłane wiadomości.

Grupy użytkowników muszą mieć zdefiniowaną właściwość usrgrpid.

Zachowanie właściwości:
- wymagane, jeśli operationtype jest ustawione na „wyślij wiadomość” i opmessage_usr nie jest ustawione
opmessage_usr array Użytkownicy, do których mają być wysyłane wiadomości.

Użytkownicy muszą mieć zdefiniowaną właściwość userid.

Zachowanie właściwości:
- wymagane, jeśli operationtype jest ustawione na „wyślij wiadomość” i opmessage_grp nie jest ustawione

Operacja aktualizacji akcji

Obiekt operacji aktualizacji akcji definiuje operację, która zostanie wykonana po zaktualizowaniu problemu (dodaniu komentarza, potwierdzeniu, zmianie ważności lub ręcznym zamknięciu). Operacje aktualizacji są możliwe tylko dla akcji wyzwalaczy i usług. Ma następujące właściwości.

Właściwość Type Opis
operationtype integer Typ operacji.

Możliwe wartości:
0 - wyślij wiadomość;
1 - skrypt globalny;
12 - powiadom wszystkich zaangażowanych.

Zachowanie właściwości:
- required
opcommand object Skrypt globalny do wykonania.

Skrypt globalny musi mieć zdefiniowaną właściwość scriptid.

Zachowanie właściwości:
- required jeśli operationtype jest ustawione na „skrypt globalny”
opcommand_grp array Grupy hostów, na których mają być uruchamiane skrypty globalne.

Grupy hostów muszą mieć zdefiniowaną właściwość groupid.

Zachowanie właściwości:
- required jeśli eventsource obiektu Action object jest ustawione na „zdarzenie utworzone przez wyzwalacz”, operationtype jest ustawione na „skrypt globalny”, a opcommand_hst nie jest ustawione
opcommand_hst array Host, na którym mają być uruchamiane skrypty globalne.

Hosty muszą mieć zdefiniowaną właściwość hostid.

Zachowanie właściwości:
- required jeśli eventsource obiektu Action object jest ustawione na „zdarzenie utworzone przez wyzwalacz”, operationtype jest ustawione na „skrypt globalny”, a opcommand_grp nie jest ustawione
opmessage object Obiekt zawierający dane o wiadomości wysyłanej przez operację aktualizacji.

Obiekt wiadomości operacji jest opisany szczegółowo powyżej.
opmessage_grp array Grupy użytkowników, do których mają być wysyłane wiadomości.

Grupy użytkowników muszą mieć zdefiniowaną właściwość usrgrpid.

Zachowanie właściwości:
- required jeśli operationtype jest ustawione na „wyślij wiadomość”, a opmessage_usr nie jest ustawione
opmessage_usr array Użytkownicy, do których mają być wysyłane wiadomości.

Użytkownicy muszą mieć zdefiniowaną właściwość userid.

Zachowanie właściwości:
- required jeśli operationtype jest ustawione na „wyślij wiadomość”, a opmessage_grp nie jest ustawione

Filtr akcji

Obiekt filtra akcji definiuje zestaw warunków, które muszą zostać spełnione, aby wykonać skonfigurowane operacje akcji. Ma następujące właściwości.

Właściwość Typ Opis
conditions array Zestaw warunków filtra używanych do filtrowania wyników. Warunki zostaną posortowane zgodnie z kolejnością ich występowania w formule.

Zachowanie właściwości:
- wymagane
evaltype integer Metoda obliczania warunku filtra.

Możliwe wartości:
0 - And/Or;
1 - And;
2 - Or;
3 - Wyrażenie niestandardowe.

Zachowanie właściwości:
- wymagane
eval_formula string Wygenerowane wyrażenie, które będzie używane do obliczania warunków filtra. Wyrażenie zawiera identyfikatory odnoszące się do określonych warunków filtra przez ich formulaid. Wartość eval_formula jest równa wartości formula dla filtrów z wyrażeniem niestandardowym.

Zachowanie właściwości:
- tylko do odczytu
formula string Wyrażenie zdefiniowane przez użytkownika, używane do obliczania warunków filtrów z wyrażeniem niestandardowym. Wyrażenie musi zawierać identyfikatory odnoszące się do określonych warunków filtra przez ich formulaid. Identyfikatory użyte w wyrażeniu muszą dokładnie odpowiadać tym zdefiniowanym w warunkach filtra: żaden warunek nie może pozostać nieużyty ani pominięty.

Zachowanie właściwości:
- wymagane, jeśli evaltype jest ustawione na „custom expression”

Warunek filtra akcji

Obiekt warunku filtra akcji definiuje określony warunek, który musi zostać sprawdzony przed uruchomieniem operacji akcji.

Właściwość Typ Opis
conditiontype integer Typ warunku.

Możliwe wartości, jeśli eventsource obiektu Action object jest ustawione na „zdarzenie utworzone przez wyzwalacz”:
0 - grupa hostów;
1 - host;
2 - wyzwalacz;
3 - nazwa zdarzenia;
4 - ważność wyzwalacza;
6 - okres czasu;
13 - szablon hosta;
16 - problem jest stłumiony;
25 - tag zdarzenia;
26 - wartość tagu zdarzenia.

Możliwe wartości, jeśli eventsource obiektu Action object jest ustawione na „zdarzenie utworzone przez regułę wykrywania”:
7 - IP hosta;
8 - typ wykrytej usługi;
9 - port wykrytej usługi;
10 - status wykrywania;
11 - czas trwania działania lub niedostępności;
12 - odebrana wartość;
18 - reguła wykrywania;
19 - sprawdzenie wykrywania;
20 - proxy;
21 - obiekt wykrywania.

Możliwe wartości, jeśli eventsource obiektu Action object jest ustawione na „zdarzenie utworzone przez aktywną autorejestrację agent”:
20 - proxy;
22 - nazwa hosta;
24 - metadane hosta.

Możliwe wartości, jeśli eventsource obiektu Action object jest ustawione na „zdarzenie wewnętrzne”:
0 - grupa hostów;
1 - host;
13 - szablon hosta;
23 - typ zdarzenia;
25 - tag zdarzenia;
26 - wartość tagu zdarzenia.

Możliwe wartości, jeśli eventsource obiektu Action object jest ustawione na „zdarzenie utworzone przy aktualizacji statusu usługi”:
25 - tag zdarzenia;
26 - wartość tagu zdarzenia;
27 - usługa;
28 - nazwa usługi.

Zachowanie właściwości:
- wymagane
value string Wartość do porównania.

Zachowanie właściwości:
- wymagane
value2 string Dodatkowa wartość do porównania.

Zachowanie właściwości:
- wymagane, jeśli eventsource obiektu Action object jest ustawione na „zdarzenie utworzone przez wyzwalacz”, conditiontype jest ustawione na dowolną możliwą wartość dla akcji wyzwalaczy, a typ warunku (patrz niżej) to „26”
- wymagane, jeśli eventsource obiektu Action object jest ustawione na „zdarzenie wewnętrzne”, conditiontype jest ustawione na dowolną możliwą wartość dla akcji wewnętrznych, a typ warunku (patrz niżej) to „26”
- wymagane, jeśli eventsource obiektu Action object jest ustawione na „zdarzenie utworzone przy aktualizacji statusu usługi”, conditiontype jest ustawione na dowolną możliwą wartość dla akcji usług, a typ warunku (patrz niżej) to „26”
formulaid string Dowolny unikalny identyfikator używany do odwoływania się do warunku z wyrażenia niestandardowego. Może zawierać tylko wielkie litery. Identyfikator musi zostać zdefiniowany przez użytkownika podczas modyfikowania warunków filtra, ale zostanie wygenerowany ponownie przy późniejszym żądaniu ich pobrania.
operator integer Operator warunku.

Możliwe wartości:
0 - (domyślnie) równa się;
1 - nie równa się;
2 - zawiera;
3 - nie zawiera;
4 - w;
5 - jest większe lub równe;
6 - jest mniejsze lub równe;
7 - nie w;
8 - pasuje;
9 - nie pasuje;
10 - Tak;
11 - Nie.

Aby lepiej zrozumieć, jak używać filtrów z różnymi typami wyrażeń, zobacz przykłady na stronach metod action.get i action.create.

Dla każdego typu warunku obsługiwane są następujące operatory i wartości.

Warunek Nazwa warunku Obsługiwane operatory Oczekiwana wartość
0 Grupa hostów równa się,
nie równa się		 ID grupy hostów.
1 Host równa się,
nie równa się		 ID hosta.
2 Wyzwalacz równa się,
nie równa się		 ID wyzwalacza.
3 Nazwa zdarzenia zawiera,
nie zawiera		 Nazwa zdarzenia.
4 Ważność wyzwalacza równa się,
nie równa się,
jest większe lub równe,
jest mniejsze lub równe		 Ważność wyzwalacza. Listę obsługiwanych ważności wyzwalacza można znaleźć we właściwości trigger severity property.
5 Wartość wyzwalacza równa się Wartość wyzwalacza. Listę obsługiwanych wartości wyzwalacza można znaleźć we właściwości trigger value property.
6 Okres czasu w, nie w Czas wystąpienia zdarzenia jako okres czasu.
7 IP hosta równa się,
nie równa się		 Jeden lub kilka zakresów IP do sprawdzenia, oddzielonych przecinkami. Więcej informacji o obsługiwanych formatach zakresów IP można znaleźć w sekcji konfiguracja wykrywania sieci.
8 Typ wykrytej usługi równa się,
nie równa się		 Typ wykrytej usługi. Typ usługi odpowiada typowi sprawdzenia wykrywania użytego do wykrycia usługi. Listę obsługiwanych typów można znaleźć we właściwości discovery check type property.
9 Port wykrytej usługi równa się,
nie równa się		 Jeden lub kilka zakresów portów, oddzielonych przecinkami.
10 Status wykrywania równa się Status wykrytego obiektu.

Możliwe wartości:
0 - host lub usługa działa;
1 - host lub usługa nie działa;
2 - host lub usługa wykryta;
3 - host lub usługa utracona.
11 Czas trwania działania lub niedostępności jest większe lub równe,
jest mniejsze lub równe		 Czas w sekundach określający, jak długo wykryty obiekt znajduje się w bieżącym stanie.
12 Odebrane wartości równa się,
nie równa się,
jest większe lub równe,
jest mniejsze lub równe,
zawiera,
nie zawiera		 Wartość zwrócona podczas wykonywania sprawdzenia wykrywania Zabbix agent, SNMPv1, SNMPv2 lub SNMPv3.
13 Szablon hosta równa się,
nie równa się		 ID podłączonego szablonu.
16 Problem jest stłumiony Tak, Nie Wartość nie jest wymagana: użycie operatora „Tak” oznacza, że problem musi być stłumiony, „Nie” — niestłumiony.
18 Reguła wykrywania równa się,
nie równa się		 ID reguły wykrywania.
19 Sprawdzenie wykrywania równa się,
nie równa się		 ID sprawdzenia wykrywania.
20 Proxy równa się,
nie równa się		 ID proxy.
21 Obiekt wykrywania równa się Typ obiektu, który wywołał zdarzenie wykrywania.

Możliwe wartości:
1 - wykryty host;
2 - wykryta usługa.
22 Nazwa hosta zawiera,
nie zawiera,
pasuje,
nie pasuje		 Nazwa hosta.
W warunkach autorejestracji dla operatorów pasuje i nie pasuje obsługiwane jest użycie wyrażenia regularnego.
23 Typ zdarzenia równa się Określone zdarzenie wewnętrzne.

Możliwe wartości:
0 - pozycja w stanie „nieobsługiwane”;
1 - pozycja w stanie „normalne”;
2 - reguła LLD w stanie „nieobsługiwane”;
3 - reguła LLD w stanie „normalne”;
4 - wyzwalacz w stanie „nieznane”;
5 - wyzwalacz w stanie „normalne”.
24 Metadane hosta zawiera,
nie zawiera,
pasuje,
nie pasuje		 Metadane automatycznie zarejestrowanego hosta.
Użycie wyrażenia regularnego jest obsługiwane dla operatorów pasuje i nie pasuje.
25 Tag równa się,
nie równa się,
zawiera,
nie zawiera		 Tag zdarzenia.
26 Wartość tagu równa się,
nie równa się,
zawiera,
nie zawiera		 Wartość tagu zdarzenia.
27 Usługa równa się,
nie równa się		 ID usługi.
28 Nazwa usługi równa się,
nie równa się		 Nazwa usługi.