De volgende objecten zijn direct gerelateerd aan de action
API.
Het actieobject heeft de volgende eigenschappen.
Eigenschap | Type | Beschrijving |
---|---|---|
actionid | string | (alleen-lezen) ID van de actie. |
esc_period (vereist) |
string | Standaard duur van de bewerkingsstap. Moet minimaal 60 seconden zijn. Accepteert seconden, tijdeenheid met achtervoegsel en gebruikersmacro. Let op: escalaties worden alleen ondersteund voor trigger-, interne en serviceacties, en alleen in normale bewerkingen. |
eventsource (vereist) |
integer | (constante) Type gebeurtenissen dat de actie zal behandelen. Zie de gebeurtenis "bron" eigenschap voor een lijst van ondersteunde gebeurtenistypes. |
name (vereist) |
string | Naam van de actie. |
status | integer | Of de actie is ingeschakeld of uitgeschakeld. Mogelijke waarden: 0 - (standaard) ingeschakeld; 1 - uitgeschakeld. |
pause_suppressed | integer | Of escalatie tijdens onderhoudsperiodes moet worden gepauzeerd of niet. Mogelijke waarden: 0 - Escalatie niet pauzeren; 1 - (standaard) Escalatie pauzeren. Merk op dat deze parameter alleen geldig is voor triggeracties. |
notify_if_canceled | integer | Of er een melding moet worden gegeven wanneer escalatie wordt geannuleerd. Mogelijke waarden: 0 - Geen melding bij annulering van escalatie; 1 - (standaard) Melding bij annulering van escalatie. Merk op dat deze parameter alleen geldig is voor triggeracties. |
Let op dat voor sommige methoden (update, delete) de vereiste/optionele parametercombinatie anders kan zijn.
Het actiebewerkingsobject definieert een bewerking die wordt uitgevoerd wanneer een actie wordt uitgevoerd. Het heeft de volgende eigenschappen.
Eigenschap | Type | Beschrijving |
---|---|---|
operationid | string | (alleen-lezen) ID van de actiebewerking. |
operationtype (vereist) |
geheel getal | Type bewerking. Mogelijke waarden: 0 - bericht verzenden; 1 - globaal script; 2 - toevoegen host; 3 - verwijder host; 4 - voeg toe aan hostgroep; 5 - verwijder uit hostgroep; 6 - link naar sjabloon; 7 - ontkoppel van sjabloon;<br >8 - host inschakelen; 9 - host uitschakelen; 10 - hostinventarisatiemodus instellen. Houd er rekening mee dat alleen typen '0' en '1' worden ondersteund voor trigger- en serviceacties, alleen '0' wordt ondersteund voor interne acties. Alle typen worden ondersteund voor detectie- en automatische registratieacties. |
actionid | string | (alleen-lezen) ID van de actie waartoe de bewerking behoort. |
esc_period | string | Duur van een escalatiestap in seconden. Moet langer zijn dan 60 seconden. Accepteert seconden, tijdseenheid met achtervoegsel en gebruikersmacro. Indien ingesteld op 0 of 0s, wordt de standaard actie-escalatieperiode gebruikt. Standaard: 0s. Merk op dat escalaties alleen worden ondersteund voor trigger-, interne en serviceacties, en alleen in normale operaties. |
esc_step_from | integer | Stap om escalatie te starten. Standaard: 1. Houd er rekening mee dat escalaties alleen worden ondersteund voor trigger-, interne en serviceacties, en alleen bij normale bewerkingen . |
esc_step_to | integer | Stap om escalatie te beëindigen op. Standaard: 1. Houd er rekening mee dat escalaties alleen worden ondersteund voor trigger-, interne en serviceacties, en alleen bij normale bewerkingen . |
evaltype | geheel getal | Bewerkingsvoorwaarde evaluatiemethode. Mogelijke waarden: 0 - (standaard) AND / OR; 1 - AND; 2 - OR. |
opcommand | object | Object dat gegevens bevat over een globaal script dat door de bewerking wordt uitgevoerd. Elk object heeft één volgende eigenschap: scriptid - (string) ID van het script.Vereist voor globale scriptbewerkingen. |
opcommand_grp | array | Hostgroepen om globale scripts op uit te voeren. Elk object heeft de volgende eigenschappen: opcommand_grpid - (string, alleen-lezen) ID van het object;operationid - (string, alleen-lezen) ID van de bewerking;groupid - (string) ID van de hostgroep.Vereist voor algemene scriptbewerkingen als opcommand_hst is niet ingesteld. |
opcommand_hst | array | Host om globale scripts op uit te voeren. Elk object heeft de volgende eigenschappen: opcommand_hstid - (string, alleen-lezen) ID van het object;operationsid - (string, alleen-lezen) ID van de bewerking;hostid - (string) ID van de host; indien ingesteld op 0 wordt de opdracht uitgevoerd op de huidige host.Vereist voor algemene scriptbewerkingen als opcommand_grp niet is ingesteld. |
opconditions | array | Bewerkingsvoorwaarden gebruikt voor triggeracties. Het bewerkingsvoorwaarde-object wordt hieronder in detail beschreven. |
opgroup | array | Hostgroepen waaraan hosts moeten worden toegevoegd. Elk object heeft de volgende eigenschappen: operationid - (string, alleen-lezen) ID van de bewerking;groupid - (string) ID van de hostgroep.Vereist voor bewerkingen "toevoegen aan hostgroep" en "verwijderen uit hostgroep". |
opmessage | object | Object dat de gegevens bevat over het bericht dat door de bewerking is verzonden. Het bewerkingsberichtobject wordt hieronder in detail beschreven.< br> Vereist voor berichtbewerkingen. |
opmessage_grp | array | Gebruikersgroepen waarnaar berichten moeten worden verzonden. Elk object heeft de volgende eigenschappen: operationid - (string, alleen-lezen) ID van de bewerking;usrgrpid - (string) ID van de gebruikersgroep.Vereist voor berichtbewerkingen als opmessage_usr niet is ingesteld. |
opmessage_usr | array | Gebruikers om berichten naar te verzenden. Elk object heeft de volgende eigenschappen: operationid - (string, alleen-lezen) ID van de bewerking;userid - (string) ID van de gebruiker.Vereist voor berichtbewerkingen als opmessage_grp niet is ingesteld. |
optemplate | array | Sjablonen om de hosts aan te koppelen. Elk object heeft de volgende eigenschappen: operationid - (string, alleen-lezen) ID van de bewerking;templateid - (string) ID van de sjabloon.Vereist voor bewerkingen "link naar sjabloon" en "ontkoppelen van sjabloon". |
opinventory | object | Voorraadmodus zet host op. Object heeft de volgende eigenschappen: operationid - (string, alleen-lezen) ID van de bewerking;inventory_mode - * (string)* Voorraadmodus.Vereist voor bewerkingen "Hostinventarismodus instellen". |
Het bewerkings bericht object bevat gegevens over het bericht dat worden verzonden door de operatie.
|Property|Type|Beschrijving| |--------|---------------------------------------- -----------|-----------| |default_msg|integer|Of de standaardtekst en het onderwerp van het actiebericht moeten worden gebruikt.
Mogelijke waarden:
0 - gebruik de gegevens van de bewerking;
1 - (standaard) gebruik de gegevens van het mediatype.| |mediatypeid|string|ID van het mediatype dat zal worden gebruikt om het bericht te verzenden.| |message|string|Bewerkings bericht tekst.| |subject|string|Bewerking bericht onderwerp.|
Het actie bewerkingsvoorwaarde object definieert een voorwaarde die moet zijn voldaan om de huidige bewerking uit te voeren. Het heeft de volgende eigenschappen.
|Property|Type|Beschrijving| |--------|---------------------------------------- -----------|-----------| |opconditionid|string|(alleen-lezen) ID van de actievoorwaarde| |conditiontype
(vereist)|geheel getal|Type voorwaarde.
Mogelijke waarden:
14 - gebeurtenis bevestigd.| |waarde
(verplicht)|string|Waarde om mee te vergelijken.| |operationid|string|(alleen-lezen) ID van de bewerking.| |operator|geheel getal|Conditie-operator.
Mogelijke waarden:
0 - (standaard) =.|
De volgende operatoren en waarden worden ondersteund voor elke bewerking: soort toestand.
|Voorwaarde|Voorwaarde naam|Ondersteunde operators|Verwachte waarde| |---------|--------------|-------------------|---- ----------| |14|Gebeurtenis bevestigd|=|Of de gebeurtenis is bevestigd.
Mogelijke waarden:
0 - niet bevestigd;
1 - bevestigd.|
Het actie-herstelbewerkingsobject definieert een bewerking die wordt uitgevoerd wanneer een probleem is opgelost. Herstelbewerkingen zijn mogelijk voor trigger-, interne en serviceacties. Het heeft het volgende: eigendommen.
Eigenschap | Type | Beschrijving |
---|---|---|
operationid | string | (alleen-lezen) ID van de actiebewerking. |
operationtype (vereist) |
geheel getal | Type bewerking. Mogelijke waarden voor trigger- en serviceacties: 0 - bericht verzenden; 1 - algemeen script;< br>11 - breng alle betrokkenen op de hoogte. Mogelijke waarden voor interne acties: 0 - stuur bericht; 11 - breng alle betrokkenen op de hoogte. |
actionid | string | (alleen-lezen) ID van de actie waartoe de herstelbewerking behoort. |
opcommand | object | Object bevat gegevens over een globaal actietypescript dat door de bewerking wordt uitgevoerd. Elk object heeft één volgende eigenschap: scriptid - (string) ID van het actietypescript.Vereist voor algemene scriptbewerkingen. |
opcommand_grp | array | Hostgroepen om globale scripts op uit te voeren. Elk object heeft de volgende eigenschappen: opcommand_grpid - (string, alleen-lezen) ID van het object;operationid - (string, alleen-lezen) ID van de bewerking;groupid - (string) ID van de hostgroep.Vereist voor algemene scriptbewerkingen als opcommand_hst is niet ingesteld. |
opcommand_hst | array | Host om globale scripts op uit te voeren. Elk object heeft de volgende eigenschappen: opcommand_hstid - (string, alleen-lezen) ID van het object;operationsid - (string, alleen-lezen) ID van de bewerking;hostid - (string) ID van de host; indien ingesteld op 0 wordt de opdracht uitgevoerd op de huidige host.Vereist voor algemene scriptbewerkingen als opcommand_grp niet is ingesteld. |
opmessage | object | Object dat de gegevens bevat over het bericht dat door de herstelbewerking is verzonden. Het bewerkingsberichtobject is hierboven in detail beschreven. Vereist voor berichtbewerkingen. |
opmessage_grp | array | Gebruikersgroepen waarnaar berichten moeten worden verzonden. Elk object heeft de volgende eigenschappen: operationid - (string, alleen-lezen) ID van de bewerking;usrgrpid - (string) ID van de gebruikersgroep.Vereist voor berichtbewerkingen als opmessage_usr niet is ingesteld. |
opmessage_usr | array | Gebruikers om berichten naar te verzenden. Elk object heeft de volgende eigenschappen: operationid - (string, alleen-lezen) ID van de bewerking;userid - (string) ID van de gebruiker.Vereist voor berichtbewerkingen als opmessage_grp niet is ingesteld. |
Het actie-update-bewerkingsobject definieert een bewerking die wordt uitgevoerd wanneer een probleem wordt bijgewerkt (becommentarieerd, erkend, ernst gewijzigd of handmatig gesloten). Updatebewerkingen zijn mogelijk voor trigger- en serviceacties. Het heeft de volgende eigenschappen.
Eigenschap | Type | Beschrijving |
---|---|---|
operationid | string | (alleen-lezen) ID van de actiebewerking. |
operationtype (vereist) |
geheel getal | Type bewerking. Mogelijke waarden voor trigger- en serviceacties: 0 - bericht verzenden; 1 - algemeen script;< br>12 - breng alle betrokkenen op de hoogte. |
opcommand | object | Object dat gegevens bevat over een globaal actietypescript dat door de bewerking wordt uitgevoerd. Elk object heeft één volgende eigenschap: scriptid - (string) ID van het actietypescript.Vereist voor algemene scriptbewerkingen. |
opcommand_grp | array | Hostgroepen om globale scripts op uit te voeren. Elk object heeft de volgende eigenschappen: groupid - (string) ID van de hostgroep.br>Vereist voor globale scriptbewerkingen als opcommand_hst niet is ingesteld. |
opcommand_hst | array | Host om globale scripts op uit te voeren. Elk object heeft de volgende eigenschappen: hostid - (string) ID van de host; indien ingesteld op 0 wordt de opdracht uitgevoerd op de huidige host.Vereist voor algemene scriptbewerkingen als opcommand_grp niet is ingesteld. |
opmessage | object | Object dat de gegevens bevat over het bericht dat is verzonden door de updatebewerking. Het bewerkingsberichtobject is hierboven in detail beschreven. |
opmessage_grp | array | Gebruikersgroepen om berichten naar te verzenden. Elk object heeft de volgende eigenschappen: usrgrpid - (string) ID van de gebruikersgroep.<br >Alleen vereist voor 'send message'-bewerkingen als 'opmessage_usr' niet is ingesteld. Wordt genegeerd voor 'send update message'-bewerkingen. |
opmessage_usr | array | Gebruikers om berichten naar te verzenden. Elk object heeft de volgende eigenschappen: userid - (string) ID van de gebruiker.Vereist alleen voor send message -bewerkingen als opmessage_grp niet is ingesteld.Wordt genegeerd voor send update message -bewerkingen. |
Het actiefilter object definieert een reeks voorwaarden waaraan moet worden voldaan om: de geconfigureerde actiebewerkingen uitvoeren. Het heeft het volgende: eigenschappen.
|Property|Type|Beschrijving| |--------|---------------------------------------- -----------|-----------| |voorwaarden
(vereist)|array|Set van filtervoorwaarden om te gebruiken voor het filteren van resultaten.| |evaltype
(vereist)|geheel getal|Filterconditie-evaluatiemethode.
Mogelijke waarden:
0 - en/of;
1 - en;
2 - of;
3 - aangepaste uitdrukking.| |eval_formula|string|(alleen-lezen) Gegenereerde expressie die zal worden gebruikt voor het evalueren van filtervoorwaarden. De expressie bevat ID's die verwijzen naar specifieke filtervoorwaarden door middel van de formulaid
. De waarde van eval_formula
is gelijk aan de waarde van formula
voor filters met een aangepaste expressie.| |formula|string|Door de gebruiker gedefinieerde expressie die moet worden gebruikt voor het evalueren van voorwaarden van filters met een aangepaste expressie. De expressie moet ID's bevatten die verwijzen naar specifieke filtervoorwaarden door middel van de formulaid
. De ID's die in de expressie worden gebruikt, moeten exact overeenkomen met de ID's die zijn gedefinieerd in de filtervoorwaarden: geen enkele voorwaarde mag ongebruikt blijven of worden weggelaten.
Vereist voor aangepaste expressie filters.|
Het actie filter voorwaardobject definieert een specifieke voorwaarde die moet worden gecontroleerd voordat de actiebewerkingen worden uitgevoerd.
Eigenschap | Type | Beschrijving |
---|---|---|
conditionid | string | (alleen-lezen) ID van de actievoorwaarde. |
conditiontype (vereist) |
integer | Type voorwaarde. Mogelijke waarden voor triggeracties: 0 - hostgroep; 1 - host; 2 - trigger; 3 - triggernaam; 4 - triggerernst; 6 - tijdsperiode; 13 - hostsjabloon; 16 - probleem is onderdrukt; 25 - gebeurtenistag; 26 - waarde van gebeurtenistag. Mogelijke waarden voor ontdekkingsacties: 7 - host-IP; 8 - ontdekte servicetype; 9 - ontdekte servicepoort; 10 - ontdekkingsstatus; 11 - duur van bedrijfstijd of stilstandstijd; 12 - ontvangen waarde; 18 - ontdekkingsregel; 19 - ontdekkingscontrole; 20 - proxy; 21 - ontdekkingsobject. Mogelijke waarden voor automatische registratie-acties: 20 - proxy; 22 - hostnaam; 24 - hostmetadata. Mogelijke waarden voor interne acties: 0 - hostgroep; 1 - host; 13 - hostsjabloon; 23 - gebeurtenistype; 25 - gebeurtenistag; 26 - waarde van gebeurtenistag. Mogelijke waarden voor serviceacties: 25 - gebeurtenistag; 26 - waarde van gebeurtenistag; 27 - service; 28 - servicenaam. |
value (vereist) |
string | Waarde om te vergelijken. |
value2 |
string | Secundaire waarde om te vergelijken. Vereist voor trigger-, interne en serviceacties wanneer het voorwaardetype 26 is. |
actionid | string | (alleen-lezen) ID van de actie waartoe de voorwaarde behoort. |
formulaid | string | Willekeurige unieke ID die wordt gebruikt om naar de voorwaarde te verwijzen vanuit een aangepaste expressie. Kan alleen hoofdletters bevatten. De ID moet door de gebruiker worden gedefinieerd bij het wijzigen van filtervoorwaarden, maar wordt opnieuw gegenereerd bij het opvragen ervan achteraf. |
operator | integer | Vergelijkingsoperator voor de voorwaarde. Mogelijke waarden: 0 - (standaard) is gelijk aan; 1 - is niet gelijk aan; 2 - bevat; 3 - bevat niet; 4 - in; 5 - is groter dan of gelijk aan; 6 - is kleiner dan of gelijk aan; 7 - niet in; 8 - komt overeen met; 9 - komt niet overeen met; 10 - Ja; 11 - Nee. |
Om beter te begrijpen hoe filters met verschillende soorten expressies te gebruiken, raadpleeg voorbeelden op de pagina's van de methoden action.get en action.create.
De volgende operatoren en waarden worden ondersteund voor elk voorwaardetype.
Voorwaarde | voorwaarde naam | Ondersteunde operatoren | Verwachte waarde |
---|---|---|---|
0 | Hostgroep | gelijk aan, niet gelijk aan |
Hostgroep-ID. |
1 | Host | gelijk aan, niet gelijk aan |
Host-ID. |
2 | Trigger | gelijk aan, niet gelijk aan |
Trigger-ID. |
3 | Triggernaam | bevat, bevat niet |
Triggernaam. |
4 | Triggerernst | gelijk aan, niet gelijk aan, is groter dan of gelijk aan, is kleiner dan of gelijk aan |
Triggerernst. Zie de trigger "ernst" eigenschap voor een lijst van ondersteunde triggerernsten. |
5 | Triggerwaarde | gelijk aan | Triggerwaarde. Zie de trigger "waarde" eigenschap voor een lijst van ondersteunde triggerwaarden. |
6 | Tijdsperiode | in, niet in | Tijd waarop de gebeurtenis is geactiveerd als een tijdsperiode. |
7 | Host-IP | gelijk aan, niet gelijk aan |
Een of meerdere IP-bereiken om te controleren, gescheiden door komma's. Raadpleeg de configuratie voor netwerkontdekking voor meer informatie over ondersteunde formaten van IP-bereiken. |
8 | Ontdekte servicetype | gelijk aan, niet gelijk aan |
Type ontdekte service. Het type service komt overeen met het type ontdekkingscontrole dat wordt gebruikt om de service te detecteren. Zie de eigenschap "type" van de ontdekkingscontrole voor een lijst van ondersteunde typen. |
9 | Ontdekte servicepoort | gelijk aan, niet gelijk aan |
Een of meerdere poortbereiken gescheiden door komma's. |
10 | Ontdekkingsstatus | gelijk aan | Status van een ontdekt object. Mogelijke waarden: 0 - host of service actief; 1 - host of service inactief; 2 - host of service ontdekt; 3 - host of service verloren. |
11 | Bedrijfstijd of stilstandstijd | is groter dan of gelijk aan, is kleiner dan of gelijk aan |
Tijd die aangeeft hoe lang het ontdekte object in de huidige status staat in seconden. |
12 | Ontvangen waarden | gelijk aan, niet gelijk aan, is groter dan of gelijk aan, is kleiner dan of gelijk aan, bevat, bevat niet |
Waarde die wordt geretourneerd bij het uitvoeren van een Zabbix-agent, SNMPv1, SNMPv2 of SNMPv3 ontdekkingscontrole. |
13 | Hostsjabloon | gelijk aan, niet gelijk aan |
Gekoppelde sjabloongroep-ID. |
16 | Probleem onderdrukt | Ja, Nee | Geen waarde vereist: de "Ja" operator betekent dat het probleem moet worden onderdrukt, "Nee" - niet onderdrukt. |
18 | Ontdekkingsregel | gelijk aan, niet gelijk aan |
ID van de ontdekkingsregel. |
19 | Ontdekkingscontrole | gelijk aan, niet gelijk aan |
ID van de ontdekkingscontrole. |
20 | Proxy | gelijk aan, niet gelijk aan |
ID van de proxy. |
21 | Ontdekkingsobject | gelijk aan | Type object dat de ontdekkingsgebeurtenis heeft getriggerd. Mogelijke waarden: 1 - ontdekte host; 2 - ontdekte service. |
22 | Hostnaam | bevat, bevat niet, komt overeen met, komt niet overeen met |
Hostnaam. Het gebruik van een reguliere expressie wordt ondersteund voor de operatoren komt overeen met en komt niet overeen met in autoregistratievoorwaarden. |
23 | Gebeurtenistype | gelijk aan | Specifieke interne gebeurtenis. Mogelijke waarden: 0 - item in de "niet ondersteund" toestand; 1 - item in de "normale" toestand; 2 - LLD-regel in de "niet ondersteund" toestand; 3 - LLD-regel in de "normale" toestand; 4 - trigger in de "onbekende" toestand; 5 - trigger in de "normale" toestand. |
24 | Hostmetadata | bevat, bevat niet, komt overeen met, komt niet overeen met |
Metadata van de automatisch geregistreerde host. Het gebruik van een reguliere expressie wordt ondersteund voor de operatoren komt overeen met en komt niet overeen met. |
25 | Tag | gelijk aan, niet gelijk aan, bevat, bevat niet |
Gebeurtenistag. |
26 | Tagwaarde | gelijk aan, niet gelijk aan, bevat, bevat niet |
Gebeurtenistagwaarde. |
27 | Service | gelijk aan, niet gelijk aan |
Service-ID. |
28 | Servicenaam | gelijk aan, niet gelijk aan |
Servicenaam. |