De volgende objecten zijn direct gerelateerd aan de action
API.
Het actieobject heeft de volgende eigenschappen.
Eigenschap | Type | Beschrijving |
---|---|---|
actionid | string | ID van de actie. Eigenschapsgedrag: - alleen-lezen - vereist voor updatebewerkingen |
esc_period | string | Standaardduur van de bewerkingstap. Moet minimaal 60 seconden zijn. Accepteert seconden, tijdseenheid met achtervoegsel of een gebruikersmacro. Eigenschapsgedrag: - ondersteund als eventsource is ingesteld op "gebeurtenis gemaakt door een trigger", "interne gebeurtenis" of "gebeurtenis gemaakt bij bijwerken van de servicestatus" |
eventsource | integer | Type gebeurtenissen die door de actie worden afgehandeld. Zie de eigenschap source van de gebeurtenis voor een lijst van ondersteunde gebeurtenistypes.Eigenschapsgedrag: - constant - vereist voor createbewerkingen |
name | string | Naam van de actie. Eigenschapsgedrag: - vereist voor createbewerkingen |
status | integer | Of de actie is ingeschakeld of uitgeschakeld. Mogelijke waarden: 0 - (standaard) ingeschakeld; 1 - uitgeschakeld. |
pause_symptoms | integer | Of escalatie moet worden gepauzeerd als de gebeurtenis een symptoomgebeurtenis is. Mogelijke waarden: 0 - Pauzeer escalatie niet voor symptoomproblemen; 1 - (standaard) Pauzeer escalatie voor symptoomproblemen. Eigenschapsgedrag: - ondersteund als eventsource is ingesteld op "gebeurtenis gemaakt door een trigger" |
pause_suppressed | integer | Of escalatie moet worden gepauzeerd tijdens onderhoudsperioden of niet. Mogelijke waarden: 0 - Pauzeer escalatie niet; 1 - (standaard) Pauzeer escalatie. Eigenschapsgedrag: - ondersteund als eventsource is ingesteld op "gebeurtenis gemaakt door een trigger" |
notify_if_canceled | integer | Of er moet worden gemeld wanneer escalatie wordt geannuleerd. Mogelijke waarden: 0 - Meld niet wanneer escalatie wordt geannuleerd; 1 - (standaard) Meld wanneer escalatie wordt geannuleerd. Eigenschapsgedrag: - ondersteund als eventsource is ingesteld op "gebeurtenis gemaakt door een trigger" |
Het actiebewerkingsobject definieert een bewerking die wordt uitgevoerd wanneer een actie wordt uitgevoerd. Het heeft de volgende eigenschappen.
Eigenschap | Type | Beschrijving |
---|---|---|
operationtype | integer | Type bewerking. Mogelijke waarden: 0 - bericht verzenden; 1 - globaal script; 2 - host toevoegen; 3 - host verwijderen; 4 - toevoegen aan hostgroep; 5 - verwijderen uit hostgroep; 6 - koppelen aan sjabloon; 7 - ontkoppelen van sjabloon; 8 - host inschakelen; 9 - host uitschakelen; 10 - hostinventarisatiemodus instellen. Mogelijke waarden als eventsource van Action object is ingesteld op "gebeurtenis gemaakt door een trigger" of "gebeurtenis gemaakt bij bijwerken van de servicestatus":0 - "bericht verzenden"; 1 - "globaal script". Mogelijke waarden als eventsource van Action object is ingesteld op "interne gebeurtenis":0 - "bericht verzenden". Eigenschapsgedrag: - vereist |
esc_period | string | Duur van een escalatiestap in seconden. Moet groter zijn dan 60 seconden. Accepteert seconden, tijdseenheid met achtervoegsel of een gebruikersmacro. Als ingesteld op 0 of 0s, wordt de standaard actie-escalatieperiode gebruikt. Standaard: 0s. Eigenschapsgedrag: - ondersteund als eventsource van Action object is ingesteld op "gebeurtenis gemaakt door een trigger", "interne gebeurtenis" of "gebeurtenis gemaakt bij bijwerken van de servicestatus" |
esc_step_from | integer | Stap om escalatie te starten vanaf. Standaard: 1. Eigenschapsgedrag: - ondersteund als eventsource van Action object is ingesteld op "gebeurtenis gemaakt door een trigger", "interne gebeurtenis" of "gebeurtenis gemaakt bij bijwerken van de servicestatus" |
esc_step_to | integer | Stap om escalatie te beëindigen. Standaard: 1. Eigenschapsgedrag: - ondersteund als eventsource van Action object is ingesteld op "gebeurtenis gemaakt door een trigger", "interne gebeurtenis" of "gebeurtenis gemaakt bij bijwerken van de servicestatus" |
evaltype | integer | Methode voor evaluatie van bewerkingsvoorwaarden. Mogelijke waarden: 0 - (standaard) AND / OF; 1 - AND; 2 - OF. |
opcommand | object | Globaal script om uit te voeren. Het globale script moet de eigenschap scriptid gedefinieerd hebben.Eigenschapsgedrag: - vereist als operationtype is ingesteld op "globaal script" |
opcommand_grp | array | Hostgroepen om globale scripts op uit te voeren. De hostgroepen moeten de eigenschap groupid gedefinieerd hebben.Eigenschapsgedrag: - vereist als operationtype is ingesteld op "globaal script" en opcommand_hst is niet ingesteld |
opcommand_hst | array | Host om globale scripts op uit te voeren. De hosts moeten de eigenschap hostid gedefinieerd hebben.Eigenschapsgedrag: - vereist als operationtype is ingesteld op "globaal script" en opcommand_grp is niet ingesteld |
opconditions | array | Bewerkingsvoorwaarden gebruikt voor triggeracties. Het bewerkingsvoorwaardeobject wordt hieronder in detail beschreven. |
opgroup | array | Hostgroepen om hosts aan toe te voegen. De hostgroepen moeten de eigenschap groupid gedefinieerd hebben.Eigenschapsgedrag: - vereist als operationtype is ingesteld op "toevoegen aan hostgroep" of "verwijderen uit hostgroep" |
opmessage | object | Object met gegevens over het bericht dat door de bewerking wordt verzonden. Het bewerkingsberichtobject wordt hieronder in detail beschreven. Eigenschapsgedrag: - vereist als operationtype is ingesteld op "bericht verzenden" |
opmessage_grp | array | Gebruikersgroepen om berichten naar te verzenden. De gebruikersgroepen moeten de eigenschap usrgrpid gedefinieerd hebben.Eigenschapsgedrag: - vereist als operationtype is ingesteld op "bericht verzenden" en opmessage_usr is niet ingesteld |
opmessage_usr | array | Gebruikers om berichten naar te verzenden. De gebruikers moeten de eigenschap userid gedefinieerd hebben.Eigenschapsgedrag: - vereist als operationtype is ingesteld op "bericht verzenden" en opmessage_grp is niet ingesteld |
optemplate | array | Sjablonen om de hosts aan te koppelen. De sjablonen moeten de eigenschap templateid gedefinieerd hebben.Eigenschapsgedrag: - vereist als operationtype is ingesteld op "koppelen aan sjabloon" of "ontkoppelen van sjabloon" |
opinventory | object | Hostinventarisatiemodus instellen. De inventaris moet de eigenschap inventory_mode gedefinieerd hebben.Eigenschapsgedrag: - vereist als operationtype is ingesteld op "set host inventory mode" |
Het object bewerking bericht bevat gegevens over het bericht dat door de bewerking wordt verzonden. Het heeft de volgende eigenschappen.
Eigenschap | Type | Beschrijving |
---|---|---|
default_msg | integer | Of het standaard actieberichttekst en onderwerp moet worden gebruikt. Mogelijke waarden: 0 - gebruik de gegevens van de bewerking; 1 - (standaard) gebruik de gegevens van de mediatype. |
mediatypeid | string | ID van de mediatype die wordt gebruikt om het bericht te verzenden. Eigenschapsgedrag: - ondersteund als operationtype van Actiebewerking object, Herstelactiebewerking object of Bijwerkactiebewerking object is ingesteld op "bericht verzenden", of als operationtype van Bijwerkactiebewerking object is ingesteld op "alle betrokkenen op de hoogte stellen" |
message | string | Tekst van het bewerkingsbericht. Eigenschapsgedrag: - ondersteund als default_msg is ingesteld op "gebruik de gegevens van de bewerking" |
subject | string | Onderwerp van het bewerkingsbericht. Eigenschapsgedrag: - ondersteund als default_msg is ingesteld op "gebruik de gegevens van de bewerking" |
Het object actiebewerking voorwaarde definieert een voorwaarde die moet worden vervuld om de huidige bewerking uit te voeren. Het heeft de volgende eigenschappen.
Eigenschap | Type | Beschrijving |
---|---|---|
conditiontype | integer | Type van voorwaarde. Mogelijke waarden: 14 - gebeurtenis erkend. Eigenschapsgedrag: - vereist |
value | string | Waarde om mee te vergelijken. Eigenschapsgedrag: - vereist |
operator | integer | Voorwaarde operator. Mogelijke waarden: 0 - (standaard) = |
De volgende operatoren en waarden worden ondersteund voor elk type bewerkingsvoorwaarde.
Voorwaarde | Naam voorwaarde | Ondersteunde operatoren | Verwachte waarde |
---|---|---|---|
14 | Gebeurtenis erkend | = | Of de gebeurtenis erkend is. Mogelijke waarden: 0 - niet erkend; 1 - erkend. |
Het object actie herstelbewerking definieert een bewerking die wordt uitgevoerd wanneer een probleem is opgelost. Herstelbewerkingen zijn alleen mogelijk voor trigger-, interne- en service-acties. Het heeft de volgende eigenschappen.
Eigenschap | Type | Beschrijving |
---|---|---|
operationtype | integer | Type bewerking. Mogelijke waarden als eventsource van Actieobject is ingesteld op "gebeurtenis gemaakt door een trigger" of "gebeurtenis gemaakt op service statusupdate":0 - stuur bericht; 1 - globaal script; 11 - meld iedereen. Mogelijke waarden als eventsource van Actieobject is ingesteld op "interne gebeurtenis":0 - stuur bericht; 11 - meld iedereen. Eigenschapsgedrag: - vereist |
opcommand | object | Globaal script om uit te voeren. Het globaal script moet de eigenschap scriptid gedefinieerd hebben.Eigenschapsgedrag: - vereist als operationtype is ingesteld op "globaal script" |
opcommand_grp | array | Hostgroepen om globale scripts op uit te voeren. De hostgroepen moeten de eigenschap groupid gedefinieerd hebben.Eigenschapsgedrag: - vereist als eventsource van Actieobject is ingesteld op "gebeurtenis gemaakt door een trigger", en operationtype is ingesteld op "globaal script", en opcommand_hst is niet ingesteld |
opcommand_hst | array | Host om globale scripts op uit te voeren. De hosts moeten de eigenschap hostid gedefinieerd hebben.Eigenschapsgedrag: - vereist als eventsource van Actieobject is ingesteld op "gebeurtenis gemaakt door een trigger", en operationtype is ingesteld op "globaal script", en opcommand_grp is niet ingesteld |
opmessage | object | Object met gegevens over het bericht dat wordt verzonden door de herstelbewerking. Het object berichtbewerking wordt hierboven in detail beschreven. Eigenschapsgedrag: - vereist als operationtype is ingesteld op "stuur bericht" |
opmessage_grp | array | Gebruikersgroepen om berichten naar te verzenden. De gebruikersgroepen moeten de eigenschap usrgrpid gedefinieerd hebben.Eigenschapsgedrag: - vereist als operationtype is ingesteld op "stuur bericht" en opmessage_usr is niet ingesteld |
opmessage_usr | array | Gebruikers om berichten naar te verzenden. De gebruikers moeten de eigenschap userid gedefinieerd hebben.Eigenschapsgedrag: - vereist als operationtype is ingesteld op "stuur bericht" en opmessage_grp is niet ingesteld |
Het object actie updatebewerking definieert een bewerking die wordt uitgevoerd wanneer een probleem wordt bijgewerkt (voorzien van commentaar, erkend, ernst gewijzigd of handmatig gesloten). Updatebewerkingen zijn alleen mogelijk voor trigger- en serviceacties. Het heeft de volgende eigenschappen.
Eigenschap | Type | Beschrijving |
---|---|---|
operationtype | integer | Type bewerking. Mogelijke waarden: 0 - stuur bericht; 1 - globaal script; 12 - meld iedereen. Eigenschapsgedrag: - vereist |
opcommand | object | Globaal script om uit te voeren. Het globaal script moet de eigenschap scriptid gedefinieerd hebben.Eigenschapsgedrag: - vereist als operationtype is ingesteld op "globaal script" |
opcommand_grp | array | Hostgroepen om globale scripts op uit te voeren. De hostgroepen moeten de eigenschap groupid gedefinieerd hebben.Eigenschapsgedrag: - vereist als eventsource van Actieobject is ingesteld op "gebeurtenis gemaakt door een trigger", en operationtype is ingesteld op "globaal script", en opcommand_hst is niet ingesteld |
opcommand_hst | array | Host om globale scripts op uit te voeren. De hosts moeten de eigenschap hostid gedefinieerd hebben.Eigenschapsgedrag: - vereist als eventsource van Actieobject is ingesteld op "gebeurtenis gemaakt door een trigger", en operationtype is ingesteld op "globaal script", en opcommand_grp is niet ingesteld |
opmessage | object | Object met gegevens over het bericht dat wordt verzonden door de updatebewerking. Het object berichtbewerking wordt hierboven in detail beschreven. |
opmessage_grp | array | Gebruikersgroepen om berichten naar te verzenden. De gebruikersgroepen moeten de eigenschap usrgrpid gedefinieerd hebben.Eigenschapsgedrag: - vereist als operationtype is ingesteld op "stuur bericht" en opmessage_usr is niet ingesteld |
opmessage_usr | array | Gebruikers om berichten naar te verzenden. De gebruikers moeten de eigenschap userid gedefinieerd hebben.Eigenschapsgedrag: - vereist als operationtype is ingesteld op "stuur bericht" en opmessage_grp is niet ingesteld |
Het actiefilterobject definieert een reeks voorwaarden die moeten worden voldaan om de geconfigureerde actiebewerkingen uit te voeren. Het heeft de volgende eigenschappen.
Eigenschap | Type | Beschrijving |
---|---|---|
conditions | array | Set van filtervoorwaarden om te gebruiken voor het filteren van resultaten. Eigenschapsgedrag: - vereist |
evaltype | integer | Evaluatiemethode van filtervoorwaarden. Mogelijke waarden: 0 - en/of; 1 - en; 2 - of; 3 - aangepaste expressie. Eigenschapsgedrag: - vereist |
eval_formula | string | Gegenereerde expressie die zal worden gebruikt voor het evalueren van filtervoorwaarden. De expressie bevat ID's die specifieke filtervoorwaarden aangeven op basis van hun formulaid . De waarde van eval_formula is gelijk aan de waarde van formula voor filters met een aangepaste expressie.Eigenschapsgedrag: - alleen-lezen |
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 specifieke filtervoorwaarden aangeven op basis van hun formulaid . De in de expressie gebruikte ID's moeten exact overeenkomen met degenen die zijn gedefinieerd in de filtervoorwaarden: geen enkele voorwaarde mag ongebruikt of weggelaten blijven.Eigenschapsgedrag: - vereist als evaltype is ingesteld op "aangepaste expressie" |
Het object voor actiefiltervoorwaarde definieert een specifieke voorwaarde die gecontroleerd moet worden voordat de actiebewerkingen worden uitgevoerd.
Eigenschap | Type | Beschrijving |
---|---|---|
conditiontype | integer | Type voorwaarde. Mogelijke waarden als eventsource van Actie-object is ingesteld op "gebeurtenis gemaakt door een trigger":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 als eventsource van Actie-object is ingesteld op "gebeurtenis gemaakt door een ontdekkingsregel":7 - host-IP; 8 - ontdekte servicetype; 9 - ontdekte servicepoort; 10 - ontdekkingsstatus; 11 - bedrijfstijd of stilstandtijd; 12 - ontvangen waarde; 18 - ontdekkingsregel; 19 - ontdekkingscontrole; 20 - proxy; 21 - ontdekkingsobject. Mogelijke waarden als eventsource van Actie-object is ingesteld op "gebeurtenis gemaakt door actieve agent-autoregistratie":20 - proxy; 22 - hostnaam; 24 - hostmetadata. Mogelijke waarden als eventsource van Actie-object is ingesteld op "interne gebeurtenis":0 - hostgroep; 1 - host; 13 - hostsjabloon; 23 - gebeurtenistype; 25 - gebeurtenistag; 26 - waarde van gebeurtenistag. Mogelijke waarden als eventsource van Actie-object is ingesteld op "gebeurtenis gemaakt bij statusupdate van de service":25 - gebeurtenistag; 26 - waarde van gebeurtenistag; 27 - service; 28 - servicenaam. Eigenschapsgedrag: - vereist |
value | string | Waarde om te vergelijken. Eigenschapsgedrag: - vereist |
value2 | string | Secundaire waarde om te vergelijken. Eigenschapsgedrag: - vereist als eventsource van Actie-object is ingesteld op "gebeurtenis gemaakt door een trigger", conditiontype is ingesteld op een mogelijke waarde voor triggeracties en het type voorwaarde (zie hieronder) is "26"- vereist als eventsource van Actie-object is ingesteld op "interne gebeurtenis", conditiontype is ingesteld op een mogelijke waarde voor interne acties en het type voorwaarde (zie hieronder) is "26"- vereist als eventsource van Actie-object is ingesteld op "gebeurtenis gemaakt bij statusupdate van de service", conditiontype is ingesteld op een mogelijke waarde voor serviceacties en het type voorwaarde (zie hieronder) is "26" |
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. |
operator | integer | Voorwaarde-operator. Mogelijke waarden: 0 - (standaard) gelijk aan; 1 - 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, zie voorbeelden op de action.get en action.create pagina's.
De volgende operators en waarden worden ondersteund voor elk type voorwaarde.
Voorwaarde | Voorwaardenaam | Ondersteunde operators | 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. Raadpleeg de trigger severity eigenschap voor een lijst van ondersteunde triggerernst. |
5 | Triggertoevoeg | gelijk aan | Triggerwaarde. Raadpleeg de trigger value eigenschap voor een lijst van ondersteunde triggertoevoegen. |
6 | Tijdsperiode | in, niet in | Tijd waarop de gebeurtenis werd getriggerd als een tijdsperiode. |
7 | Host-IP | gelijk aan, niet gelijk aan |
Eén of meerdere IP-bereiken om te controleren, gescheiden door komma's. Raadpleeg de netwerkontdekkingsconfiguratie sectie voor meer informatie over ondersteunde indelingen 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. Raadpleeg de ontdekkingscontrole type eigenschap voor een lijst van ondersteunde typen. |
9 | Ontdekte servicepoort | gelijk aan, niet gelijk aan |
Eén of meerdere poortbereiken, gescheiden door komma's. |
10 | Ontdekkingsstatus | gelijk aan | Status van een ontdekt object. Mogelijke waarden: 0 - host of service up; 1 - host of service down; 2 - host of service ontdekt; 3 - host of service verloren. |
11 | Bedrijfstijd of stilstandtijd | is groter dan of gelijk aan, is kleiner dan of gelijk aan |
Tijd die aangeeft hoe lang het ontdekte object in de huidige status is 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 |
ID van het gekoppelde sjabloon. |
16 | Probleem is onderdrukt | Ja, Nee | Geen waarde vereist: het gebruik van de "Ja" operator betekent dat het probleem onderdrukt moet worden, "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 operators komt overeen met en komt niet overeen met in autoregistratievoorwaarden. |
23 | Gebeurtenistype | gelijk aan | Specifieke interne gebeurtenis. Mogelijke waarden: 0 - item in "niet ondersteund" staat; 1 - item in "normale" staat; 2 - LLD-regel in "niet ondersteund" staat; 3 - LLD-regel in "normale" staat; 4 - trigger in "onbekende" staat; 5 - trigger in "normale" staat. |
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 operators 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 |
Waarde van de gebeurtenistag. |
27 | Service | gelijk aan, niet gelijk aan |
Service-ID. |
28 | Servicenaam | gelijk aan, niet gelijk aan |
Servicenaam. |