Els següents objectes són relacionats amb l'API action
.
Lobjecte acció té les propietats següents.
Propietat | Tipus | Descripció |
---|---|---|
actionid | ID | ID de l'acció. Comportament de la propietat: - només lectura - obligatori per a operacions d'actualització |
esc_period | cadena | Durada de la passa de l'operació per defecte. Ha de ser com a mínim de 60 segons. Accepta segons, unitat de temps amb sufix o una macro d'usuari. Comportament de la propietat: - admès si eventsource és establert en "esdeveniment creat per un trigger", "esdeveniment intern" o "esdeveniment creat a l'actualització de l'estat del servei" |
eventsource | enter | Tipus d'esdeveniments que gestionarà l'acció. Consulteu la propietat source de l'esdeveniment per obtindre una llista d'esdeveniments compatibles tipus.Comportament de la propietat: - constant - obligatori per a operacions de creació |
name | cadena | Nom de l'acció. Comportament de la propietat: - obligatori per a les operacions de creació |
status | enter | Si l'acció és activada o desactivada. Valors possibles: 0 - (per defecte) activat; 1 - desactivat. |
pause_symptoms | enter | Si s'ha d'aturar l'escalada si l'esdeveniment és un esdeveniment símptoma. Valors possibles: 0 - No atureu l'escalada per problemes de símptomes; 1 - (per defecte) Posa en pausa l'escalada per problemes de símptomes. Comportament de la propietat: - admès si eventsource s'estableix com a "esdeveniment creat per un trigger" |
pause_suppressed | enter | Si s'ha d'aturar l'escalada durant els períodes de manteniment o no. Valors possibles: 0 - No atureu l'escalada; 1 - (per defecte) Atura l'escalada. Comportament de la propietat: - admès si eventsource és establert en "esdeveniment creat per un trigger" |
notify_if_canceled | enter | Si cal notificar quan es cancel·li l'escalada. Valors possibles: 0 - No aviseu quan es cancel·li l'escalada; 1 - (per defecte) Notifiqueu quan es cancel·li l'escalada. Comportament de la propietat: - admès si eventsource s'estableix com a "esdeveniment creat per un trigger" |
L'objecte d'operació d'acció defineix una operació que s'executarà quan s'executi una acció. Té les propietats següents:
Propietat | Tipus | Descripció |
---|---|---|
operationtype | enter | Tipus d'operació. Valors possibles: 0 - Enviar missatge; 1 - script global; 2 - afegir equip; 3 - esborrar equip; 4 - afegir a un grup d'equips; 5 - treure d'un grup d'equips; 6 - enllaçar a una plantilla; 7 - desenllaçar de la plantilla; 8 - activar equip; 9 - desactivar equip; 10 - establir el mode d'inventari de l'equip. Els valors possibles d' eventsource de l'objecte acció si és establert a "esdeveniment creat per trigger" o "esdeveniment creat per acutlització d'estat del servei":0 - "enviar missatge"; 1 - "script global". Valors possibles si l' eventsource de l'objecte acció és establert a "esdeveniment intern":0 - "enviar missatge". Comportament de la propietat: - obligatori |
esc_period | string | Durada de l'escalada, en segons. Ha d'ésser superior a 60 segons. Accepta segons, unitats de temps amb sufixe i macro d'usuari. Si s'estableix a 0, s'emprarà el període d'escalat de l'acció pe defecte. Per defecte: 0s. Comportament de la propietat: - admès si l' eventsource de l'objecte acció s'ha establert a "esdeveniment creat per trigger", "esdeveniment intern", o "esdeveniment creat en actualitzar l'estat del servei" |
esc_step_from | enter | Graó de partida de l'escalat. Comportament de la propietat: - admès si l' eventsource de l'objecte acció s'ha establert a "esdeveniment creat per trigger", "esdeveniment intern", o "esdeveniment creat en actualitzar l'estat del servei" |
esc_step_to | enter | Graó d'escalada destí. Per defecte: 1. Comportament de la propietat: - admès si l' eventsource de l'objecte acció s'ha establert a "esdeveniment creat per trigger", "esdeveniment intern", o "esdeveniment creat en actualitzar l'estat del servei" |
evaltype | enter | Mètode d'avaluació de la condició d'operació. Valors possibles: 0 - (per defecte) AND / OR; 1 - AND; 2 - OR. |
opcommand | objecte | Script global a executar. L'script global ha de tindre la propietat scriptid definida.Comportament de la propietat: - obligatori si l' operationtype s'ha establert a "script global" |
opcommand_grp | matriu | Grups d'equips per executar scripts globals. Els grups d'equips han de tindre la propietat groupid definida.Comportament de la propietat: - obligatori si l' operationtype s'ha establert a "script global" i no s'ha definit opcommand_hst |
opcommand_hst | matriu | Equip que executa els scripts globals. Els grups d'equips han de tindre la propietat hostid definidaComportament de la propietat: - obligatori si l' operationtype s'ha establert a "script global" i no s'ha definit opcommand_grp |
opconditions | matriu | Condicions d'operació emprades per accions de triggers. L'objecte de condició d'operació és descrit en detall més avall. |
opgroup | array | Grups d'equips on afegir equips. Els grups d'equips han de tindre la propietat groupid definida.Comportament de la propietat: - obligatori si l' operationtype s'ha establert a "afegir a grup d'equips" o "treure de grup d'equips" |
opmessage | objecte | Objecte que conté la informació sobre el missatge enviat per l'operació. L'objecte missatge de l'operació és detallat avall. Comportament de la propietat: - obligatori si l' operationtype s'ha establert a "enviar missatge" |
opmessage_grp | matriu | Grups d'usuaris als qui enviar missatges. Els grups d'usuaris han de tindre la propietat usrgrpid definida.Comportament de la propietat: - obligatori si l' operationtype s'ha establert a "enviar missatge" i no s'ha establert pas opmessage_usr |
opmessage_usr | matriu | Usuaris als qui enviar missatges. Els usuaris han de tindre la propietat userid definida.Comportament de la propietat: - obligatori si l' operationtype s'ha establert a "enviar missatge" i no s'ha establert pas opmessage_grp |
optemplate | matriu | Plantilles a les que vincular-hi equips. Les plantilles han de tindre la propietat templateid definida.Comportament de la propietat: - obligatori si l' operationtype s'ha establert a "enllaçar a plantilla" o "desenllaçar de plantilla" |
opinventory | objecte | Mode d'inventari definit com equip. L'inventari han de tindre la propietat inventory_mode definida.Comportament de la propietat: - obligatori si l' operationtype s'ha establert a "definir el mode d'inventari d'equip" |
L'objecte de missatge d'opieració conté informació sobre el missatge que s'enviarà per l'operació.
Propietat | Tipus | Descripció |
---|---|---|
default_msg | enter | Fer ús del text i/o de l'assumpte del missatge. Valors possibles: 0 - fer ús de la informació de l'operació; 1 - (per defecte) fer ús de la informació del tipus de medi. |
mediatypeid | cadena | ID del tipus de medi que s'emprarà per enviar el missatge. Comportament de la propietat: - admès si l' operationtype de l'objecte d'operació d'acció, objecte d'operació de recuperació d'acció, o l'objecte d'operació d'actualització d'acció s'estableix a "enviar missatge", o si l'operationtype de l'objecte d'operació d'actualització d'acció s'ha establert a "notificar a tots els implicats" |
missatge | cadena | Text del missatge de l'operació. Comportament de la propietat: - admès si el default_msg s'ha establert a "emprar la informació de l'operació" |
assumpte | cadena | Assumpte del missatge de l'operació. Comportament de la propietat: - admès si el default_msg s'ha establert a "emprar la informació de l'operació" |
L'objecte condició d'operació d'acció defineix una condició que ha d'encaixar per executar l'operació en curs. Té les següents propietats.
Propietat | Tipus | Descripció |
---|---|---|
conditiontype | enter | Tipus de condició. Valors possibles: 14 - esdeveniment reconegut. Comportament de la propietat: - obligatori |
value | cadena | Valor amb el que comparar. Comportament de la propietat: - obligatori |
operator | enter | Operador de condició. Valors possibles: 0 - (per defecte) = |
Els següents operadors i valors són suportats per cada tipus de condició d'operació.
Condició | Nom de la condició | Operadors admesos | Valor esperat |
---|---|---|---|
14 | Esdeveniment reconegut | = | Si l'esdeveniment s'ha reconegut. Valors possibles: 0 - no reconegut pas; 1 - reconegut. |
L'objecte d'operació de recuperació d'acció defineix una operació que es realitzarà quan es resolgui un problema. Les operacions de recuperació són possibles només per a accions de triggers, internes i de servei. Té les següents propietats.
Propietat | Tipus | Descripció |
---|---|---|
operationtype | enter | Tipus d'operació. Valors possibles si eventsource d'objecte d'acció s'estableix a "esdeveniment creat per un trigger" o "esdeveniment creat a l'actualització de l'estat del servei": 0 - enviar missatge; 1 - script global; 11 - notificar a tots els implicats. Valors possibles si eventsource d'objecte d'acció s'estableix a "esdeveniment intern":0 - enviar missatge; 11 - notificar a tots els implicats. Comportament de la propietat: - obligatori |
opcommand | objecte | Script global per executar. L'script global ha de tindre la propietat scriptid definida.Comportament de la propietat : - obligatori si operationtype és definit com a "script global" |
opcommand_grp | array | Grups d'equips per executar scripts globals. Els grups d'equips han de tindre la propietat groupid definida.Comportament de la propietat: - obligatori si eventsource d'objecte d'acció s'estableix a "esdeveniment creat per un trigger", i operationtype s'estableix a "script global" i opcommand_hst no és pas establert |
opcommand_hst | array | Equip per executar scripts globals. Els equips han de tindre la propietat hostid definida.Comportament de la propietat: - obligatori si eventsource d'objecte d'acció s'estableix a "esdeveniment creat per un trigger", i operationtype s'estableix a "script global" i opcommand_grp no està configurat |
opmessage | objecte | Objecte que conté les dades sobre el missatge enviat per l'operació de recuperació. L'objecte de missatge de l'operació és descrit en detall més amunt. Comportament de la propietat: - obligatori si operationtype és configurat a "enviar missatge" |
opmessage_grp | array | Grups d'usuaris als qui enviar missatges. Els grups d'usuaris han de tindre la propietat usrgrpid definida.Comportament de la propietat: - obligatori si operationtype és definit com a "enviar missatge" i opmessage_usr no és pas definit |
opmessage_usr | array | Usuaris als qui enviar missatges. Els usuaris han de tindre definida la propietat userid .Comportament de la propietat: - obligatori si operationtype és establert a "enviar missatge" i omessage_grp no és pas configurat |
L'objecte d'operació d'actualització de l'acció defineix una operació que s'efectuarà quan s'actualitzi un problema (comentat, reconegut, gravetat modificada o tancat manualment). Les operacions d'actualització són possibles només per les accions de triggers i de serveis. Tenen les següents propietats:
Propietat | Tipus | Descripció |
---|---|---|
operationtype | enter | Tipus d'operació. Valors possibles: 0 - enviar missatge; 1 - script global; 12 - notificar a tots els implicats. Comportament de la propietat: - obligatori |
opcommand | objecte | Script global per executar. L'script global ha de tindre la propietat scriptid definida.Comportament de la propietat: - obligatori si operationtype és definit com a "script global" |
opcommand_grp | taula | Grups d'equips per executar scripts globals. Els grups d'equips han de tindre la propietat groupid definida.Comportament de la propietat: - obligatori si eventsource d'objecte d'acció s'estableix a "esdeveniment creat per un trigger", i operationtype s'estableix a "script global" i opcommand_hst no és establert |
opcommand_hst | taula | Equip per executar scripts globals. Els equips han de tindre la propietat hostid definida.Comportament de la propietat: - obligatori si eventsource de Action object s'estableix a "esdeveniment creat per un trigger", i operationtype s'estableix a "script global" i opcommand_grp no és configurat |
opmessage | objecte | Objecte que conté les dades sobre el missatge enviat per l'operació d'actualització. L'objecte de missatge de l'operació és descrit en detall més amunt. |
opmessage_grp | taula | Grups d'usuaris als qui enviar missatges. Els grups d'usuaris han de tindre la propietat usrgrpid definida.Comportament de la propietat: - obligatori si operationtype és definit com a "enviar missatge" i opmessage_usr no és pas definit |
opmessage_usr | taula | Usuaris als qui enviar missatges. Els usuaris han de tindre definida la propietat userid .Comportament de la propietat: - obligatori si operationtype és establert a "enviar missatge" i omessage_grp no és pas configurat |
### Filtre d'accions
L'object de filtre d'acció defineix un recull de condicions que s'han d'especificar per efectuar les operacions d'acció configurades. Té les propietats següents:
Propietat | Tipus | Descripció |
---|---|---|
condicions | taula | Conjunt de condicions de filtre a emprar per filtrar els resultats. Les condicions s'ordenaran de la mateixa manera que s'han introduït a la fòrmula. Comportament de la propietat: - obligatori |
evaltype | enter | Mètode d'avaluació de la condició de filtre. Valors possibles: 0 - i/o ; 1 - i ; 2 - o ; 3 - expressió personalitzada. Comportament de la propietat: - obligatori |
eval_formula | cadena | Expressió generada que s'emprarà per avaluar les condicions de filtre. L'expressió conté els identificadors que fan referència a les condicions de filtre específiques per la seva formulaid . El valor de eval_formula és igual al valor de formula per als filtres amb una expressió personalitzada.Comportament de la propietat: - només lectura |
formula | cadena | Expressió definida per l'usuari a emprar per avaluar les condicions dels filtres amb una expressió personalitzada. L'expressió ha de contindre els identificadors fent referència a les condicions de filtre específiques per la seva formulaid . Els identificadors emprats a l'expressió han de correspondre exactament als definits a les condicions de filtre: cap condició pot restar sense ús o omesa.Comportament de la propietat: - obligatori si evaltype s'ha establert a "expressió personalitzada" |
Aquest objecte defineix una condició específica que s'ha de verificar abans d'executar les operacions d'acció.
Propietat | Tipus | Descripció |
---|---|---|
conditiontype | enter | Tipus de condició. Valors possibles si eventsource de l'objecte d'acció s'ha establert a "esdeveniment creat per un trigger":0 - grup d'equips; 1 - equip; 2 - trigger; 3 - nom del trigger; 4 - gravetat del trigger; 6 - període; 13 - model d'equip; 16 - problema esborrat; 25 - etiqueta d'esdeveniment; 26 - valor de l'etiqueta d'esdeveniment. Valors possibles per les accions de descoberta: 7 - IP de l'equip; 8 - tipus de servei de descoberta; 9 - port del servei de descoberta;< br>10 - estat de descoberta; 11 - durada de disponibilitat o indisponibilitat; 12 - valor rebut; 18 - regla de descoberta; 19 - verificació de descoberta; 20 - proxy;<br >21 - objecte de descoberta. Valors possibles per les accions d'enregistrament automàtic: 20 - proxy; 22 - nom d'equip; 24 - metadades de l'equip. Valors possibles per les accions internes: 0 - grup d'equips; 1 - equip; 13 - model d'equip; 23 - tipus d'esdeveniment; 25 - etiqueta d'esdeveniment; 26 - valor de l'etiqueta d'esdeveniment. Valors possibles per les accions de servei: 25 - etiqueta d'esdeveniment; 26 - valor de l'etiqueta d'esdeveniment; 27 - servei;<br >28 - nom del servei. Comportament de la propietat: - obligatori |
valor | cadena | Valor a comparar. Comportament de la propietat: - obligatori |
value2 |
cadena | Valor secundari a comparar. Comportament de la propietat: - obligatori si eventsource de l'objecte d'acció s'ha establert a "esdeveniment creat per un trigger", conditiontype s'ha establert a qualsevol valor possible per les accions de triggers, i el tipus de condició (veieu més avall) és "26"- obligatori si eventsource d'objecte d'acció s'estableix en "internal event", conditiontype s'estableix en qualsevol valor possible per a les accions internes i el tipus de condició ( vegeu a continuació) és "26"- obligatori si eventsource d'objecte d'acció s'estableix a "esdeveniment creat a l'actualització de l'estat del servei", conditiontype s'estableix a qualsevol valor possible per les accions de servei i el tipus de condició (veieu més avall) és "26" |
formulaid | cadena | Identificador únic arbitrari emprat per referenciar la condició a partir d'una expressió personalitzada. Només pot contindre lletres majúscules. L'identificador s'ha de definir per l'usuari durant la modificació de condicions de filtre, però es generarà de nou a petició posterior. |
operador | enter | Operador de condició. Valors possibles: 0 - (per defecte) és igual; 1 - no és pas igual; 2 - conté; 3 - no ho conté pas; 4 - entre; 5 - és superior o igual a; 6 - inferior o igual a; 7 - no és pas entre; 8 - correspon;<br >9 - no correspon pas; 10 - Sí; 11 - No. |
Per entendre millor com emprar els filtres amb diferents tipus d'expressions, consulteu els exemples a les pàgines dels mètodes action.get i action.create.
Els operadors i valors següents s'admeten per cada tipus de condició.
Condició | Nom de la condició | Operadors admesos | Valor esperat | |
---|---|---|---|---|
0 | Grup d'equips | igual, no és igual |
identificador del grup d'equips. | |
1 | Equip | igual, no és igual |
identificador d'equip. | |
2 | Trigger | igual, no és igual |
identificador de trigger. | |
3 | Nom de l'esdeveniment | conté, no conté pas |
Nom de l'esdeveniment. | |
4 | Gravetat del trigger | igual, no és igual, superior o igual, inferior o igual |
Gravetat del trigger. Consulteu la propietat "trigger "severity" per obtindre una llista de gravetats de triggers admeses. | |
5 | Valor de trigger | igual | Valor de trigger. Consulteu la propietat "valor" del trigger per obtindre una llista dels valors de triggers admesos. | |
6 | Període de temps | entre, no entre | Hora en la que l'esdeveniment s'ha disparat al període. | |
7 | IP de l'equip | igual, no és igual |
Un o més llocs IP a verificar separats per comes. Consulteu la secció configuració de la descoberta de xarxa per tindre més informació dels format admesos dels llocs IP. | |
8 | Tipus de servei descobert | igual, no és igual |
Tipus de servei descobert. El tipus de servei descobert correspon al tipus de control de descoberta emprat per detectar el servei. Consulteu la propietat "tipus" de la verificació de descoberta per obtindre la llista dels tipus admesos. | |
9 | Port de servei descobert | igual, diferent |
Un o més llocs de ports separats per comes. | |
10 | Estat de descoberta | igual | Estat d'un objecte descobert. Valors possibles: 0 - equip o servei actiu; 1 - equip o servei desactivat; 2 - equip o servei descobert; 3 - equip o servei perdut. |
|
11 | Durada de disponibilitat o indisponibilitat | superior o igual, inferior o igual |
Durada indicant quan de temps l'objecte descobert és a l'estat actual, en segons. | |
12 | Valors rebuts | iguals, diferents, superiors o iguals, inferiors o iguals, conté, no conté pas |
Valor retornat quan s'executa un agent Zabbix, control de descoberta SNMPv1, SNMPv2 o SNMPv3. | |
13 | Model d'equip | igual, no és igual |
ID de model vinculat. | |
16 | El problema s'ha esborrat | Sí, No | No cal pas cap valor: l'ús de l'operador "Sí" vol dir que el problema s'ha esborrat, "No" - no s'ha esborrat pas. | |
18 | Regla de descoberta | igual, no és igual |
ID de la regla de descoberta. | |
19 | Control de descoberta | igual, no és igual |
ID del control de descoberta. | |
20 | Proxy | igual, no és igual |
ID del proxy. | |
21 | Objecte de descoberta | igual | Tipus d'objecte que ha desencadenat l'esdeveniment de descoberta. Valors possibles: 1 - equip descobert; 2 - servei descobert. |
|
22 | Nom d'equip | conté, no conté pas, correspon, no correspon pas |
Nom d'equip. L'ús d'una expressió regular s'admet per els operadors correspon i no correspon pas a les condicions d'auto-enregistrement. |
|
23 | Tipus d'esdeveniment | igual | Esdeveniment intern específic. Valors possibles: 0 - element amb estat "no admès" ; 1 - element amb esetat "normal"; 2 - Regla LLD amb estat "no admesa" ; 3 - Regla LLD amb estat "normal" ; 4 - Trigger amb estat "desconegut" ; 5 - Trigger amb estat "normal". |
|
24 | Metadades de l'equip | conté, no conté pas, correspon, no correspon pas |
Metadades de l'equip registrat automàticament. L'ús d'una expressió regular s'admet per als operadors correspon i no correspon pas. |
|
25 | Etiqueta | igual, no és igual, conté, no conté pas |
Etiqueta d'esdeveniment. | |
26 | Valor de l'etiqueta | igual, no és igual, conté, no conté pas |
Valor de l'etiqueta d'esdeveniment. | |
27 | Servei | igual, no és igual a |
ID de servei. | |
28 | Nom del servei | igual, no és igual |
Nom del servei. |