Els següents objectes són relacionats amb l'API action
.
L'objecte acció té aquestes propietats.
Propietat | Tipus | Descripció |
---|---|---|
actionid | string | (nomes lectura) ID de l'acció. |
esc_period (obligatori) |
string | Durada per defecte de l'etapa d'operació. Com a mínim, ha de tindre 60 segons. Accepta segons, unitat de temps com a sufixe i macro d'usuari. Veieu que l'escalat és suportat només per a triggers, accions internes i de servei; i només en operacions normals. |
eventsource (obligatori) |
enter | (constant) Tipus d'esdeveniments que l'acció manipularà. Consulteu la propietat event "source" property per obtindre una llista de tipus d'esdeveniments suportats. |
name (obligatori) |
string | Nom de l'acció. |
status | enter | Si l'acció és habilitada o no ho és pas. Valors possibles: 0 - (per defecte) actiu; 1 - desactivat. |
pause_suppressed | enter | Si aturar o no l'escalament durant els períodes de manteniment. Valors possibles: 0 - No aturar l'escalament; 1 - (per defecte) Aturar-lo. Veieu que aquest paràmetre només és vàlid per a accions de triggers. |
notify_if_canceled | enter | Si hem de notificar quan l'escalada és cancel·lada. Valors possibles: 0 - No notificar la cancel·lació de l'escalada; 1 - (per defecte) Notificar-ne la cancel·lació. Veieu que aquest paràmetre és vàlid només per a accions de triggers. |
Veieu també que, per a alguns dels mètodes (com ara actualitzar i esborrar) la combinació de paràmetre requerit o opcional és diferent.
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ó |
---|---|---|
operationid | string | (només lectura) ID de l'operació d'acció. |
operationtype (obligatori) |
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. Veieu que els tipus '0' i '1' són suportats per accions de trigger i servei, i '0' només es suporta per accions internes. Tots els tipus són suportats per accions de descobriment i autoregistre. |
actionid | cadena | (només lectura) ID de l'acció a qui pertany l'operació. |
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. Veieu que l'escalat es suporta només per a triggers, accions internes i de servei, i només en operacions normals. |
esc_step_from | enter | Graó de partida de l'escalat. Per defecte: 1. Veieu que l'escalada és suportada només per triggers, accions internes i de servei, i només en operacions normals. |
esc_step_to | enter | Graó d'escalada destí. Per defecte: 1. Veieu que l'escalat és suportat només per a triggers, accions internes i de servei; i només en operacions normals. |
evaltype | enter | Mètode d'avaluació de la condició d'operació. Valors possibles: 0 - (per defecte) AND / OR; 1 - AND; 2 - OR. |
opcommand | objecte | Objecte que conté informació del global script executat per l'operació. Cada objecte té una de les següents propietats: scriptid - (cadena) ID de l'script.Obligatori per a operacions d'escript globals. |
opcommand_grp | matriu | Grups d'equips per executar scripts globals. Cada objecte té les propietats següents: opcommand_grpid - (cadena, només lectura) ID de l'objecte;operationid - (cadena, només lectura) ID de l'operació;groupid - (cadena) ID del grup d'equips.Obligatori per a operacions d'script globals si no s'estableix opcommand_hst . |
opcommand_hst | matriu | Equip que executa els scripts globals. Cada objecte té les propietats següents: opcommand_hstid - (cadena, només lectura) ID de l'objecte;operationid - (cadena, només lectura) ID de l'operació;hostid - (cadena) ID de l'equip; si s'estableix a 0, la comanda s'executarà a l'equip actualt.Obligatori per a operacions d'scripts globals si no s'estableix 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. Cada objecte té les propietats següents: operationid - (cadena, només lectura) ID de l'operació;groupid - (cadena) ID del grup d'equips.Obligatori per les operacions d'"afegir al grup d'equips" i "treure del grup d'equips". |
opmessage | objecte | Objecte que conté la informació sobre el missatge enviat per l'operació. L'objecte missatge de l'opieració és detallat avall. Obligatori per operacions de missatges. |
opmessage_grp | matriu | Grups d'usuaris als qui enviar missatges. Cada objecte té les propietats següents:: operationid - (cadena, només lectura) ID de l'operació;usrgrpid - (cadena) ID del grup d'usuaris.Obligatori per a operacions de missatge, si no s'ha pas definit opmessage_usr . |
opmessage_usr | matriu | Usuaris als qui enviar missatges. Cada objecte té les propietats següents: operationid - (cadena, només lectura) ID of the operation;userid - (cadena) ID de l'usuari.Obligatori per a operacions de missatge si no hi s'ha pas definit opmessage_grp . |
optemplate | matriu | Plantilles a les que vincular-hi equips. Cada objecte té les propietats següents: operationid - (cadena, només lectura) ID de l'operació;templateid - (cadena) ID de la plantilla.Obligatori per a les operacions "enllaçar a plantilla" i "desenllaçar de plantilla". |
opinventory | objecte | Mode d'inventari definit com equip. L'objecte té les propietats següents: operationid - (cadena, només lectura) ID de l'opieració;inventory_mode - (cadena) Mode d'inventari.Obligatori per a operacions "Establir mode d'inventari d'equips". |
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. |
missatge | cadena | Text del missatge de l'operació. |
assumpte | cadena | Assumpte del missatge 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ó |
---|---|---|
opconditionid | string | (només lectura) ID de la condició d'operació d'acció |
conditiontype (obligatori) |
integer | Tipus de condició. Valors possibles: 14 - esdeveniment reconegut. |
value (obligatori) |
string | Valor amb el que comparar. |
operationid | string | (només lectura) ID de l'operació. |
operator | integer | 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 s'efectuarà quan un problema sigui resolt. Les operacions de recuperació són possibles per els triggers i accions internes i de servei. Té les propietats següents.
Propietat | Tipus | Descripció |
---|---|---|
operationid | string | (només lectura) ID de l'operació d'acció. |
operationtype (obligatori) |
integer | Tipus d'operació. Valors possibles per al trigger i accions de servei: 0 - enviar missatge; 1 - script global; 11 - notificar a tots els implicats. Valors possibles per les accions internes: 0 - enviar missatge; 11 - notificar a tots els implicats. |
actionid | string | (només lectura) ID de l'acció a qui pertany l'operació de recuperació. |
opcommand | object | Objecte que conté informació de l'script del tipus d'acció global que executa l'operació. Cada objecte té una de les següents propietats: scriptid - (string) ID de l'escript del tipus d'acció.Obligatori per a operacions d'script globals. |
opcommand_grp | array | Grups d'equips on s'executaran els scripts globals. Cada objecte té les propietats següents: opcommand_grpid - (string, només lectura) ID de l'objecte;operationid - (string, només lectura) ID de l'operació;groupid - (string) ID del grup d'equips.Obligatori per les operacions d'scripts globals si no s'ha establert opcommand_hst . |
opcommand_hst | array | Equip on correran els scripts globals. Cada objecte té les propietats següents: opcommand_hstid - (string, només lectura) ID de l'objecte;operationid - (string, només lectura) ID de l'operació;hostid - (string) ID de l'equip; si s'estableix a 0, la comanda s'executarà a l'equip actual.Obligatori per les operacions d'scripts globals si no s'ha establert opcommand_grp . |
opmessage | object | Objecte que conté la informació sobre el missatge que s'ha enviat per l'operació de recuperació. L'objecte missatge de l'operació es descriu en detall més amunt. Obligatori per a operacions de missatges. |
opmessage_grp | array | Grups d'usuaris als qui enviar els missatges. Cada objecte té les propietats següents: operationid - (string, només lectura) ID de l'operació;usrgrpid - (string) ID del grup d'usuaris.Obligatori per les operacions de missatges si no s'ha establert opmessage_usr . |
opmessage_usr | array | Usuaris a qui enviar els missatges. Cada objecte té les propietats següents: operationid - (string, només lectura) ID de l'operació;userid - (string) ID de l'usuari.Obligatori per les operacions de missatges si no s'ha establert opmessage_grp . |
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 per les accions de triggers i de serveis. Tenen les següents propietats:
Propietat | Tipus | Descripció |
---|---|---|
operationid | string | (només lectura) identificador de l'operació d'acció. |
operationtype (obligatori) |
integer | Tipus d'operació. Valors possibles per les accions de trigger i de servei: 0 - enviar un missatge; 1 - script global; 12 - informar a totes les persones implicades. |
opcommand | object | Object que conté les dades de l'script del tipus d'acció global executada per l'operació. Cada objecte té la propietat següent: scriptid - (string) identificador de l'script de tipus d'acció.Obligatori per les operacions d'script global. |
opcommand_grp | array | Grups d'equips on executar els scripts globals. Cada objecte té les propietats següents: groupid - (string) identificador del grup d'equips.< br>Obligatori per les operacions d'script global si no s'ha definit opcommand_hst . |
opcommand_hst | array | Equip on executar els scripts globals. Cada objecte té les propietats següents: hostid - (string) identificador de l'equip; si es defineix a 0, la comanda s'executarà a l'equip actual.Obligatori per les operacions d'script global si no s'ha definit opcommand_grp . |
opmessage | object | Object que conté les dades del missatge enviat per l'operació d'actualització. L'objecte de missage d'operació es descriu en detall aquí. |
opmessage_grp | array | Groups d'usuaris als qui enviar els missatges. Cada objecte té les propietats següents: usrgrpid - (string) identificador del grup d'usuaris.>Obligatori només per les operacions send message si no s'ha definit opmessage_usr .Ignorat per les operacions send update message . |
opmessage_usr | array | Usuaris als qui enviar els missatges. Cada objecte té les propietats següents: userid - (string) identificador de l'usuari.Obligatori només per les operacions send message si no s'ha definit pas opmessage_grp .Ignorat per les operacions |
### 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 (obligatori) |
array | Conjunt de condicions de filtre a emprar per filtrar els resultats. |
evaltype (obligatori) |
integer | Mètode d'avaluació de la condició de filtre. Valors possibles: 0 - i/o ; 1 - i ; 2 - o ; 3 - expressió personalitzada. |
eval_formula | string | (només lectura) 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. |
formula | string | 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.Obligatori per als filtres d'expressió personalitzats. |
Aquest objecte defineix una condició específica que s'ha de verificar abans d'executar les operacions d'acció
Propietat | Tipus | Descripció |
---|---|---|
conditionid | string | (només lectura) Identificador de la condició d'acció. |
conditiontype (obligatori) |
enter | Tipus de condició. Valors possibles per les accions dels triggers: 0 - grup d'equips; 1 - equip; 2 - trigger; 3 - nom de l'esdeveniment; 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. |
valor (obligatori) |
string | Valor a comparar. |
value2 |
string | Valor secundari a comparar. Obligatori per les accions de triggers, internes i de servei quan el tipus de condició sigui 26. |
actionid | string | (només lectura) Identificador de l'acció a qui pertany la condició. |
formulaid | string | 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 et 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. |