Darbības objekts

Tālāk norādītie objekti ir tieši saistīti ar action API.

Darbība

Darbības objektam ir tālāk norādītie rekvizīti.

Rekvizīts Tips Apraksts
actionid ID Darbības ID.

Rekvizīta darbība:
- tikai lasāms
- obligāts atjaunināšanas operācijām
esc_period string Noklusējuma operācijas soļa ilgums. Tam jābūt vismaz 60 sekundēm. Var norādīt sekunžu skaitu (piemēram, 60, 300), vērtību ar laika sufiksu (piemēram, 30s, 1m, 2h) vai lietotāja makro.

Rekvizīta darbība:
- atbalstīts, ja eventsource ir iestatīts uz "event created by a trigger", "internal event" vai "event created on service status update"
eventsource integer Notikumu veids, ko apstrādās darbība.

Atbalstīto notikumu veidu sarakstu skatiet notikuma source rekvizītā.

Rekvizīta darbība:
- konstants
- obligāts izveides operācijām
name string Darbības nosaukums.

Rekvizīta darbība:
- obligāts izveides operācijām
status integer Norāda, vai darbība ir iespējota vai atspējota.

Iespējamās vērtības:
0 - (noklusējums) iespējota;
1 - atspējota.
pause_symptoms integer Norāda, vai eskalācija ir jāaptur, ja notikums ir simptomu notikums.

Iespējamās vērtības:
0 - neapturēt eskalāciju simptomu problēmām;
1 - (noklusējums) apturēt eskalāciju simptomu problēmām.

Rekvizīta darbība:
- atbalstīts, ja eventsource ir iestatīts uz "event created by a trigger"
pause_suppressed integer Norāda, vai apkopes periodos eskalācija ir jāaptur.

Iespējamās vērtības:
0 - neapturēt eskalāciju;
1 - (noklusējums) apturēt eskalāciju.

Rekvizīta darbība:
- atbalstīts, ja eventsource ir iestatīts uz "event created by a trigger"
notify_if_canceled integer Norāda, vai jānosūta paziņojums, kad eskalācija tiek atcelta.

Iespējamās vērtības:
0 - nesūtīt paziņojumu, kad eskalācija tiek atcelta;
1 - (noklusējums) nosūtīt paziņojumu, kad eskalācija tiek atcelta.

Rekvizīta darbība:
- atbalstīts, ja eventsource ir iestatīts uz "event created by a trigger"

Darbības operācija

Darbības operācijas objekts definē operāciju, kas tiks veikta, kad darbība tiks izpildīta. Tam ir tālāk norādītās īpašības.

Īpašība Tips Apraksts
operationtype integer Operācijas tips.

Iespējamās vērtības:
0 - nosūtīt ziņojumu;
1 - globālais skripts;
2 - pievienot hostu;
3 - noņemt hostu;
4 - pievienot hostu grupai;
5 - noņemt no hostu grupas;
6 - piesaistīt veidni;
7 - atsaistīt veidni;
8 - iespējot hostu;
9 - atspējot hostu;
10 - iestatīt hosta inventarizācijas režīmu;
13 - pievienot hosta tagus;
14 - noņemt hosta tagus.

Iespējamās vērtības, ja Action object eventsource ir iestatīts uz "event created by a trigger" vai "event created on service status update":
0 - "send message";
1 - "global script".

Iespējamā vērtība, ja Action object eventsource ir iestatīts uz "internal event":
0 - "send message".

Īpašības darbība:
- obligāta
esc_period string Eskalācijas soļa ilgums sekundēs. Tam jābūt lielākam par 60 sekundēm. Pieņem sekunžu skaitu (piemēram, 60, 300), vērtību ar laika sufiksu (piemēram, 30s, 1m, 2h) vai lietotāja makro. Ja iestatīta vērtība 0 vai 0s, tiks izmantots noklusējuma darbības eskalācijas periods.

Noklusējums: 0s.

Īpašības darbība:
- atbalstīta, ja Action object eventsource ir iestatīts uz "event created by a trigger", "internal event" vai "event created on service status update"
esc_step_from integer Solis, no kura sākt eskalāciju.

Noklusējums: 1.

Īpašības darbība:
- atbalstīta, ja Action object eventsource ir iestatīts uz "event created by a trigger", "internal event" vai "event created on service status update"
esc_step_to integer Solis, ar kuru pabeigt eskalāciju.

Noklusējums: 1.

Īpašības darbība:
- atbalstīta, ja Action object eventsource ir iestatīts uz "event created by a trigger", "internal event" vai "event created on service status update"
evaltype integer Operācijas nosacījumu izvērtēšanas metode.

Iespējamās vērtības:
0 - (noklusējums) And/Or;
1 - And;
2 - Or.
opcommand object Izpildāmais globālais skripts.

Globālajam skriptam jābūt definētai scriptid īpašībai.

Īpašības darbība:
- obligāta, ja operationtype ir iestatīts uz "global script"
opcommand_grp array Hostu grupas, kurās izpildīt globālos skriptus.

Hostu grupām jābūt definētai groupid īpašībai.

Īpašības darbība:
- obligāta, ja operationtype ir iestatīts uz "global script" un opcommand_hst nav iestatīts
opcommand_hst array Hosts, kuros izpildīt globālos skriptus.

Hostiem jābūt definētai hostid īpašībai.

Īpašības darbība:
- obligāta, ja operationtype ir iestatīts uz "global script" un opcommand_grp nav iestatīts
opconditions array Darbības nosacījumi, kas tiek izmantoti trigeru darbībām.

Darbības nosacījumu objekts ir detalizēti aprakstīts tālāk.
opgroup array Hostu grupas, kurām pievienot hostus.

Hostu grupām jābūt definētai groupid īpašībai.

Īpašības darbība:
- obligāta, ja operationtype ir iestatīts uz "add to host group" vai "remove from host group"
opmessage object Objekts, kas satur datus par ziņojumu, kuru nosūta operācija.

Darbības ziņojuma objekts ir detalizēti aprakstīts tālāk.

Īpašības darbība:
- obligāta, ja operationtype ir iestatīts uz "send message"
opmessage_grp array Lietotāju grupas, kurām nosūtīt ziņojumus.

Lietotāju grupām jābūt definētai usrgrpid īpašībai.

Īpašības darbība:
- obligāta, ja operationtype ir iestatīts uz "send message" un opmessage_usr nav iestatīts
opmessage_usr array Lietotāji, kuriem nosūtīt ziņojumus.

Lietotājiem jābūt definētai userid īpašībai.

Īpašības darbība:
- obligāta, ja operationtype ir iestatīts uz "send message" un opmessage_grp nav iestatīts
optemplate array Veidnes, ko piesaistīt hostiem.

Veidnēm jābūt definētai templateid īpašībai.

Īpašības darbība:
- obligāta, ja operationtype ir iestatīts uz "link template" vai "unlink template"
opinventory object Inventarizācijas režīms, kas jāiestata hostam.

Inventarizācijai jābūt definētai inventory_mode īpašībai.

Īpašības darbība:
- obligāta, ja operationtype ir iestatīts uz "set host inventory mode"
optag array Hosta tagi, ko pievienot vai noņemt.

Tagiem jābūt definētai tag īpašībai.
value īpašība nav obligāta.

Īpašības darbība:
- atbalstīta, ja operationtype ir iestatīts uz "add host tags" vai "remove host tags".

Darbības operācijas ziņojums

Operācijas ziņojuma objekts satur datus par ziņojumu, kas tiks nosūtīts ar operāciju. Tam ir šādas īpašības.

Īpašība Tips Apraksts
default_msg integer Vai izmantot noklusējuma darbības ziņojuma tekstu un tematu.

Iespējamās vērtības:
0 - izmantot datus no operācijas;
1 - (noklusējums) izmantot datus no medija tipa.
mediatypeid ID Ziņojuma nosūtīšanai izmantotā medija tipa ID.

Īpašības darbība:
- atbalstīts, ja Darbības operācijas objekta, Darbības atkopšanas operācijas objekta vai Darbības atjaunināšanas operācijas objekta operationtype ir iestatīts uz "send message", vai ja Darbības atjaunināšanas operācijas objekta operationtype ir iestatīts uz "notify all involved"
message string Operācijas ziņojuma teksts.

Īpašības darbība:
- atbalstīts, ja default_msg ir iestatīts uz "use the data from the operation"
subject string Operācijas ziņojuma temats.

Īpašības darbība:
- atbalstīts, ja default_msg ir iestatīts uz "use the data from the operation"

Darbības operācijas nosacījums

Darbības operācijas nosacījuma objekts definē nosacījumu, kam jābūt izpildītam, lai veiktu pašreizējo operāciju. Tam ir šādas īpašības.

Īpašība Type Apraksts
conditiontype integer Nosacījuma tips.

Iespējamās vērtības:
14 - notikums apstiprināts.

Īpašības darbība:
- obligāts
value string Vērtība, ar ko salīdzināt.

Īpašības darbība:
- obligāts
operator integer Nosacījuma operators.

Iespējamās vērtības:
0 - (noklusējums) =

Tālāk ir norādīti operatori un vērtības, kas tiek atbalstītas katram operācijas nosacījuma tipam.

Nosacījums Nosacījuma nosaukums Atbalstītie operatori Sagaidāmā vērtība
14 Notikums apstiprināts = Vai notikums ir apstiprināts.

Iespējamās vērtības:
0 - nav apstiprināts;
1 - apstiprināts.

Darbības atkopšanas operācija

Darbības atkopšanas operācijas objekts definē operāciju, kas tiks izpildīta, kad problēma būs novērsta. Atkopšanas operācijas ir iespējamas tikai trigeru, iekšējo un pakalpojumu darbībām. Tam ir šādas īpašības.

Īpašība Tips Apraksts
operationtype integer Operācijas tips.

Iespējamās vērtības, ja Darbības objekta eventsource ir iestatīts uz "notikums, ko izveidojis trigeris" vai "notikums, kas izveidots pakalpojuma statusa atjaunināšanas laikā":
0 - sūtīt ziņojumu;
1 - globālais skripts;
11 - paziņot visiem iesaistītajiem.

Iespējamās vērtības, ja Darbības objekta eventsource ir iestatīts uz "iekšējais notikums":
0 - sūtīt ziņojumu;
11 - paziņot visiem iesaistītajiem.

Īpašības darbība:
- obligāts
opcommand object Izpildāmais globālais skripts.

Globālajam skriptam jābūt definētai īpašībai scriptid.

Īpašības darbība:
- obligāts, ja operationtype ir iestatīts uz "globālais skripts"
opcommand_grp array Hostu grupas, kurās palaist globālos skriptus.

Hostu grupām jābūt definētai īpašībai groupid.

Īpašības darbība:
- obligāts, ja Darbības objekta eventsource ir iestatīts uz "notikums, ko izveidojis trigeris", un operationtype ir iestatīts uz "globālais skripts", un opcommand_hst nav iestatīts
opcommand_hst array Hosts, kurā palaist globālos skriptus.

Hostiem jābūt definētai īpašībai hostid.

Īpašības darbība:
- obligāts, ja Darbības objekta eventsource ir iestatīts uz "notikums, ko izveidojis trigeris", un operationtype ir iestatīts uz "globālais skripts", un opcommand_grp nav iestatīts
opmessage object Objekts, kas satur datus par ziņojumu, ko nosūta atkopšanas operācija.

Operācijas ziņojuma objekts ir detalizēti aprakstīts iepriekš.

Īpašības darbība:
- obligāts, ja operationtype ir iestatīts uz "sūtīt ziņojumu"
opmessage_grp array Lietotāju grupas, kurām sūtīt ziņojumus.

Lietotāju grupām jābūt definētai īpašībai usrgrpid.

Īpašības darbība:
- obligāts, ja operationtype ir iestatīts uz "sūtīt ziņojumu" un opmessage_usr nav iestatīts
opmessage_usr array Lietotāji, kuriem sūtīt ziņojumus.

Lietotājiem jābūt definētai īpašībai userid.

Īpašības darbība:
- obligāts, ja operationtype ir iestatīts uz "sūtīt ziņojumu" un opmessage_grp nav iestatīts

Darbības atjaunināšanas operācija

Darbības atjaunināšanas operācijas objekts definē operāciju, kas tiks izpildīta, kad problēma tiek atjaunināta (tai pievienots komentārs, tā ir apstiprināta, mainīta tās nopietnība vai tā ir manuāli aizvērta). Atjaunināšanas operācijas ir iespējamas tikai trigeru un pakalpojumu darbībām. Tam ir šādas īpašības.

Īpašība Tips Apraksts
operationtype integer Operācijas tips.

Iespējamās vērtības:
0 - sūtīt ziņojumu;
1 - globālais skripts;
12 - paziņot visiem iesaistītajiem.

Īpašības darbība:
- obligāta
opcommand object Izpildāmais globālais skripts.

Globālajam skriptam jābūt definētai scriptid īpašībai.

Īpašības darbība:
- obligāta, ja operationtype ir iestatīts uz "globālais skripts"
opcommand_grp array Hostu grupas, kurās palaist globālos skriptus.

Hostu grupām jābūt definētai groupid īpašībai.

Īpašības darbība:
- obligāta, ja Darbības objekta eventsource ir iestatīts uz "notikums, ko izveidojis trigeris", operationtype ir iestatīts uz "globālais skripts" un opcommand_hst nav iestatīts
opcommand_hst array Hosts, kurā palaist globālos skriptus.

Hostiem jābūt definētai hostid īpašībai.

Īpašības darbība:
- obligāta, ja Darbības objekta eventsource ir iestatīts uz "notikums, ko izveidojis trigeris", operationtype ir iestatīts uz "globālais skripts" un opcommand_grp nav iestatīts
opmessage object Objekts, kas satur datus par ziņojumu, ko nosūta atjaunināšanas operācija.

Operācijas ziņojuma objekts ir detalizēti aprakstīts iepriekš.
opmessage_grp array Lietotāju grupas, kurām sūtīt ziņojumus.

Lietotāju grupām jābūt definētai usrgrpid īpašībai.

Īpašības darbība:
- obligāta, ja operationtype ir iestatīts uz "sūtīt ziņojumu" un opmessage_usr nav iestatīts
opmessage_usr array Lietotāji, kuriem sūtīt ziņojumus.

Lietotājiem jābūt definētai userid īpašībai.

Īpašības darbība:
- obligāta, ja operationtype ir iestatīts uz "sūtīt ziņojumu" un opmessage_grp nav iestatīts

Darbības filtrs

Darbības filtra objekts definē nosacījumu kopu, kam jābūt izpildītai, lai veiktu konfigurētās darbības operācijas. Tam ir šādas īpašības.

Īpašība Tips Apraksts
conditions array Filtra nosacījumu kopa, ko izmantot rezultātu filtrēšanai. Nosacījumi tiks sakārtoti to izvietojuma secībā formulā.

Īpašības darbība:
- obligāta
evaltype integer Filtra nosacījumu novērtēšanas metode.

Iespējamās vērtības:
0 - Un/Vai;
1 - Un;
2 - Vai;
3 - Pielāgota izteiksme.

Īpašības darbība:
- obligāta
eval_formula string Ģenerēta izteiksme, kas tiks izmantota filtra nosacījumu novērtēšanai. Izteiksme satur ID, kas atsaucas uz konkrētiem filtra nosacījumiem pēc to formulaid. eval_formula vērtība ir vienāda ar formula vērtību filtriem ar pielāgotu izteiksmi.

Īpašības darbība:
- tikai lasāma
formula string Lietotāja definēta izteiksme, kas tiks izmantota filtru ar pielāgotu izteiksmi nosacījumu novērtēšanai. Izteiksmei jāsatur ID, kas atsaucas uz konkrētiem filtra nosacījumiem pēc to formulaid. Izteiksmē izmantotajiem ID precīzi jāsakrīt ar tiem, kas definēti filtra nosacījumos: neviens nosacījums nedrīkst palikt neizmantots vai izlaists.

Īpašības darbība:
- obligāta, ja evaltype ir iestatīts uz "pielāgota izteiksme"

Darbības filtra nosacījums

Darbības filtra nosacījuma objekts definē konkrētu nosacījumu, kas jāpārbauda pirms darbības operāciju izpildes.

Property Type Apraksts
conditiontype integer Nosacījuma tips.

Iespējamās vērtības, ja Action object eventsource ir iestatīts uz "event created by a trigger":
0 - hostu grupa;
1 - hosts;
2 - trigeris;
3 - notikuma nosaukums;
4 - trigera smaguma pakāpe;
6 - laika periods;
13 - hostu veidne;
16 - problēma ir apspiesta;
25 - notikuma tags;
26 - notikuma taga vērtība.

Iespējamās vērtības, ja Action object eventsource ir iestatīts uz "event created by a discovery rule":
7 - hosta IP adrese;
8 - atklātā servisa tips;
9 - atklātā servisa ports;
10 - atklāšanas statuss;
11 - darbspējas vai dīkstāves ilgums;
12 - saņemtā vērtība;
18 - atklāšanas noteikums;
19 - atklāšanas pārbaude;
20 - starpniekserveris;
21 - atklāšanas objekts;
29 - starpniekserveru grupa.

Iespējamās vērtības, ja Action object eventsource ir iestatīts uz "event created by active agent autoregistration":
20 - starpniekserveris;
22 - hosta nosaukums;
24 - hosta metadati;
29 - starpniekserveru grupa.

Iespējamās vērtības, ja Action object eventsource ir iestatīts uz "internal event":
0 - hostu grupa;
1 - hosts;
13 - hostu veidne;
23 - notikuma tips;
25 - notikuma tags;
26 - notikuma taga vērtība.

Iespējamās vērtības, ja Action object eventsource ir iestatīts uz "event created on service status update":
25 - notikuma tags;
26 - notikuma taga vērtība;
27 - serviss;
28 - servisa nosaukums.

Property behavior:
- required
value string Vērtība, ar kuru salīdzināt.

Property behavior:
- required
value2 string Sekundārā vērtība, ar kuru salīdzināt.

Property behavior:
- required if eventsource of Action object is set to "event created by a trigger", conditiontype is set to any possible value for trigger actions, and the type of condition (see below) is "26"
- required if eventsource of Action object is set to "internal event", conditiontype is set to any possible value for internal actions, and the type of condition (see below) is "26"
- required if eventsource of Action object is set to "event created on service status update", conditiontype is set to any possible value for service actions, and the type of condition (see below) is "26"
formulaid string Patvaļīgs unikāls ID, ko izmanto, lai atsauktos uz nosacījumu pielāgotā izteiksmē. Var saturēt tikai lielos burtus. ID lietotājam jādefinē, modificējot filtra nosacījumus, taču pēc tam, kad tie tiek pieprasīti, tas tiks ģenerēts no jauna.
operator integer Nosacījuma operators.

Iespējamās vērtības:
0 - (default) ir vienāds ar;
1 - nav vienāds ar;
2 - satur;
3 - nesatur;
4 - ir iekļauts;
5 - ir lielāks par vai vienāds ar;
6 - ir mazāks par vai vienāds ar;
7 - nav iekļauts;
8 - atbilst;
9 - neatbilst;
10 - Jā;
11 - Nē.

Lai labāk izprastu, kā izmantot filtrus ar dažādu tipu izteiksmēm, skatiet piemērus metožu action.get un action.create lapās.

Tālāk norādītie operatori un vērtības tiek atbalstīti katram nosacījuma tipam.

Nosacījums Nosacījuma nosaukums Atbalstītie operatori Paredzamā vērtība
0 Hostu grupa ir vienāds ar,
nav vienāds ar		 Hostu grupas ID.
1 Hosts ir vienāds ar,
nav vienāds ar		 Hosta ID.
2 Trigeris ir vienāds ar,
nav vienāds ar		 Trigera ID.
3 Notikuma nosaukums satur,
nesatur		 Notikuma nosaukums.
4 Trigera smaguma pakāpe ir vienāds ar,
nav vienāds ar,
ir lielāks par vai vienāds ar,
ir mazāks par vai vienāds ar		 Trigera smaguma pakāpe. Atbalstīto trigera smaguma pakāpju sarakstu skatiet trigera severity īpašībā.
5 Trigera vērtība ir vienāds ar Trigera vērtība. Atbalstīto trigera vērtību sarakstu skatiet trigera value īpašībā.
6 Laika periods ir iekļauts, nav iekļauts Laiks, kad notikums tika aktivizēts, kā laika periods.
7 Hosta IP adrese ir vienāds ar,
nav vienāds ar		 Viens vai vairāki pārbaudāmie IP diapazoni, atdalīti ar komatiem. Papildinformāciju par atbalstītajiem IP diapazonu formātiem skatiet sadaļā tīkla atklāšanas konfigurēšana.
8 Atklātā servisa tips ir vienāds ar,
nav vienāds ar		 Atklātā servisa tips. Servisa tips atbilst atklāšanas pārbaudes tipam, kas tika izmantots servisa noteikšanai. Atbalstīto tipu sarakstu skatiet atklāšanas pārbaudes type īpašībā.
9 Atklātā servisa ports ir vienāds ar,
nav vienāds ar		 Viens vai vairāki portu diapazoni, atdalīti ar komatiem.
10 Atklāšanas statuss ir vienāds ar Atklātā objekta statuss.

Iespējamās vērtības:
0 - hosts vai serviss darbojas;
1 - hosts vai serviss nedarbojas;
2 - hosts vai serviss ir atklāts;
3 - hosts vai serviss ir pazudis.
11 Darbspējas vai dīkstāves ilgums ir lielāks par vai vienāds ar,
ir mazāks par vai vienāds ar		 Laiks sekundēs, kas norāda, cik ilgi atklātais objekts atrodas pašreizējā statusā.
12 Saņemtās vērtības ir vienāds ar,
nav vienāds ar,
ir lielāks par vai vienāds ar,
ir mazāks par vai vienāds ar,
satur,
nesatur		 Vērtība, kas tiek atgriezta, veicot Zabbix aģenta, SNMPv1, SNMPv2 vai SNMPv3 atklāšanas pārbaudi.
13 Hostu veidne ir vienāds ar,
nav vienāds ar		 Saistītās veidnes ID.
16 Problēma ir apspiesta Jā, Nē Vērtība nav nepieciešama: operatora "Jā" izmantošana nozīmē, ka problēmai jābūt apspiestai, bet "Nē" - ka tā nedrīkst būt apspiesta.
18 Atklāšanas noteikums ir vienāds ar,
nav vienāds ar		 Atklāšanas noteikuma ID.
19 Atklāšanas pārbaude ir vienāds ar,
nav vienāds ar		 Atklāšanas pārbaudes ID.
20 Starpniekserveris ir vienāds ar,
nav vienāds ar		 Starpniekservera ID.
21 Atklāšanas objekts ir vienāds ar Objekta tips, kas aktivizēja atklāšanas notikumu.

Iespējamās vērtības:
1 - atklāts hosts;
2 - atklāts serviss.
22 Hosta nosaukums satur,
nesatur,
atbilst,
neatbilst		 Hosta nosaukums.
Automātiskās reģistrācijas nosacījumos operatoriem atbilst un neatbilst tiek atbalstītas regulārās izteiksmes.
23 Notikuma tips ir vienāds ar Konkrēts iekšējais notikums.

Iespējamās vērtības:
0 - vienums stāvoklī "not supported";
1 - vienums stāvoklī "normal";
2 - LLD noteikums stāvoklī "not supported";
3 - LLD noteikums stāvoklī "normal";
4 - trigeris stāvoklī "unknown";
5 - trigeris stāvoklī "normal".
24 Hosta metadati satur,
nesatur,
atbilst,
neatbilst		 Automātiski reģistrētā hosta metadati.
Operatoriem atbilst un neatbilst tiek atbalstītas regulārās izteiksmes.
25 Tags ir vienāds ar,
nav vienāds ar,
satur,
nesatur		 Notikuma tags.
26 Taga vērtība ir vienāds ar,
nav vienāds ar,
satur,
nesatur		 Notikuma taga vērtība.
27 Serviss ir vienāds ar,
nav vienāds ar		 Servisa ID.
28 Servisa nosaukums ir vienāds ar,
nav vienāds ar		 Servisa nosaukums.
29 Starpniekserveru grupa ir vienāds ar,
nav vienāds ar		 Starpniekserveru grupas ID.