Objeto action

Os seguintes objetos estão diretamente relacionados à API action.

Ação

O objeto action possui as seguintes propriedades.

Propriedade	Tipo	Descrição
actionid	ID	ID da ação. Comportamento da propriedade: - somente leitura - obrigatório para operações de atualização
esc_period	string	Duração padrão do passo da operação. Deve ser de pelo menos 60 segundos. Aceita segundos, unidade de tempo com sufixo ou uma macro de usuário. Comportamento da propriedade: - suportado se `eventsource` estiver definido como "evento criado por um trigger", "evento interno" ou "evento criado na atualização do status do serviço"
eventsource	integer	Tipo de eventos que a ação irá manipular. Consulte a propriedade `source` do evento para uma lista de tipos de eventos suportados. Comportamento da propriedade: - constante - obrigatório para operações de criação
name	string	Nome da ação. Comportamento da propriedade: - obrigatório para operações de criação
status	integer	Se a ação está habilitada ou desabilitada. Valores possíveis: 0 - (padrão) habilitada; 1 - desabilitada.
pause_symptoms	integer	Se deve pausar a escalonamento se o evento for um evento de sintoma. Valores possíveis: 0 - Não pausar escalonamento para problemas de sintoma; 1 - (padrão) Pausar escalonamento para problemas de sintoma. Comportamento da propriedade: - suportado se `eventsource` estiver definido como "evento criado por um trigger"
pause_suppressed	integer	Se deve pausar o escalonamento durante períodos de manutenção ou não. Valores possíveis: 0 - Não pausar escalonamento; 1 - (padrão) Pausar escalonamento. Comportamento da propriedade: - suportado se `eventsource` estiver definido como "evento criado por um trigger"
notify_if_canceled	integer	Se deve notificar quando o escalonamento for cancelado. Valores possíveis: 0 - Não notificar quando o escalonamento for cancelado; 1 - (padrão) Notificar quando o escalonamento for cancelado. Comportamento da propriedade: - suportado se `eventsource` estiver definido como "evento criado por um trigger"

Operação de ação

O objeto de operação de ação define uma operação que será executada quando uma ação for executada. Ele possui as seguintes propriedades.

Propriedade	Tipo	Descrição
operationtype	integer	Tipo de operação. Valores possíveis: 0 - enviar mensagem; 1 - script global; 2 - adicionar host; 3 - remover host; 4 - adicionar ao grupo de hosts; 5 - remover do grupo de hosts; 6 - vincular template; 7 - desvincular template; 8 - habilitar host; 9 - desabilitar host; 10 - definir modo de inventário do host; 13 - adicionar tags de host; 14 - remover tags de host. Valores possíveis se `eventsource` do objeto Action estiver definido como "evento criado por um trigger" ou "evento criado na atualização do status do serviço": 0 - "enviar mensagem"; 1 - "script global". Valores possíveis se `eventsource` do objeto Action estiver definido como "evento interno": 0 - "enviar mensagem". Comportamento da propriedade: - obrigatório
esc_period	string	Duração de um passo de escalonamento em segundos. Deve ser maior que 60 segundos. Aceita segundos, unidade de tempo com sufixo ou uma macro de usuário. Se definido como 0 ou 0s, será usado o período de escalonamento padrão da ação. Padrão: 0s. Comportamento da propriedade: - suportado se `eventsource` do objeto Action estiver definido como "evento criado por um trigger", "evento interno" ou "evento criado na atualização do status do serviço"
esc_step_from	integer	Passo para iniciar o escalonamento. Padrão: 1. Comportamento da propriedade: - suportado se `eventsource` do objeto Action estiver definido como "evento criado por um trigger", "evento interno" ou "evento criado na atualização do status do serviço"
esc_step_to	integer	Passo para finalizar o escalonamento. Padrão: 1. Comportamento da propriedade: - suportado se `eventsource` do objeto Action estiver definido como "evento criado por um trigger", "evento interno" ou "evento criado na atualização do status do serviço"
evaltype	integer	Método de avaliação da condição da operação. Valores possíveis: 0 - (padrão) AND / OR; 1 - AND; 2 - OR.
opcommand	object	Script global a ser executado. O script global deve ter a propriedade `scriptid` definida. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "script global"
opcommand_grp	array	Grupos de hosts para executar scripts globais. Os grupos de hosts devem ter a propriedade `groupid` definida. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "script global" e `opcommand_hst` não estiver definido
opcommand_hst	array	Host para executar scripts globais. Os hosts devem ter a propriedade `hostid` definida. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "script global" e `opcommand_grp` não estiver definido
opconditions	array	Condições de operação usadas para ações de trigger. O objeto de condição de operação é descrito em detalhes abaixo.
opgroup	array	Grupos de hosts para adicionar hosts. Os grupos de hosts devem ter a propriedade `groupid` definida. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "adicionar ao grupo de hosts" ou "remover do grupo de hosts"
opmessage	object	Objeto contendo os dados sobre a mensagem enviada pela operação. O objeto de mensagem de operação é descrito em detalhes abaixo. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "enviar mensagem"
opmessage_grp	array	Grupos de usuários para enviar mensagens. Os grupos de usuários devem ter a propriedade `usrgrpid` definida. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "enviar mensagem" e `opmessage_usr` não estiver definido
opmessage_usr	array	Usuários para enviar mensagens. Os usuários devem ter a propriedade `userid` definida. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "enviar mensagem" e `opmessage_grp` não estiver definido
optemplate	array	Templates para vincular aos hosts. Os templates devem ter a propriedade `templateid` definida. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "vincular template" ou "desvincular template"
opinventory	object	Modo de inventário definido para o host. O inventário deve ter a propriedade `inventory_mode` definida. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "definir modo de inventário do host"
optag	array	Tags de host para adicionar ou remover. As tags devem ter a propriedade `tag` definida. A propriedade `value` é opcional. Comportamento da propriedade: - suportado se `operationtype` estiver definido como "adicionar tags de host" ou "remover tags de host".

Mensagem de operação de ação

O objeto de mensagem de operação contém dados sobre a mensagem que será enviada pela operação. Ele possui as seguintes propriedades.

Propriedade	Tipo	Descrição
default_msg	integer	Se deve usar o texto e o assunto padrão da mensagem de ação. Valores possíveis: 0 - usar os dados da operação; 1 - (padrão) usar os dados do tipo de mídia.
mediatypeid	ID	ID do tipo de mídia que será usado para enviar a mensagem. Comportamento da propriedade: - suportado se `operationtype` do Objeto de operação de ação, Objeto de operação de recuperação de ação ou Objeto de operação de atualização de ação estiver definido como "enviar mensagem", ou se `operationtype` do Objeto de operação de atualização de ação estiver definido como "notificar todos os envolvidos"
message	string	Texto da mensagem da operação. Comportamento da propriedade: - suportado se `default_msg` estiver definido como "usar os dados da operação"
subject	string	Assunto da mensagem da operação. Comportamento da propriedade: - suportado se `default_msg` estiver definido como "usar os dados da operação"

Condição de operação de ação

O objeto de condição de operação de ação define uma condição que deve ser atendida para executar a operação atual. Possui as seguintes propriedades.

Propriedade	Tipo	Descrição
conditiontype	integer	Tipo de condição. Valores possíveis: 14 - evento reconhecido. Comportamento da propriedade: - obrigatório
value	string	Valor a ser comparado. Comportamento da propriedade: - obrigatório
operator	integer	Operador da condição. Valores possíveis: 0 - (padrão) =

Os seguintes operadores e valores são suportados para cada tipo de condição de operação.

Condição	Nome da condição	Operadores suportados	Valor esperado
14	Evento reconhecido	=	Se o evento foi reconhecido. Valores possíveis: 0 - não reconhecido; 1 - reconhecido.

Operação de recuperação de ação

O objeto de operação de recuperação de ação define uma operação que será executada quando um problema for resolvido. As operações de recuperação são possíveis apenas para ações de trigger, internas e de serviço. Possui as seguintes propriedades.

Propriedade	Tipo	Descrição
operationtype	integer	Tipo de operação. Valores possíveis se o `eventsource` do objeto Action estiver definido como "evento criado por um trigger" ou "evento criado na atualização do status do serviço": 0 - enviar mensagem; 1 - script global; 11 - notificar todos os envolvidos. Valores possíveis se o `eventsource` do objeto Action estiver definido como "evento interno": 0 - enviar mensagem; 11 - notificar todos os envolvidos. Comportamento da propriedade: - obrigatório
opcommand	object	Script global a ser executado. O script global deve ter a propriedade `scriptid` definida. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "script global"
opcommand_grp	array	Grupos de hosts para executar scripts globais. Os grupos de hosts devem ter a propriedade `groupid` definida. Comportamento da propriedade: - obrigatório se o `eventsource` do objeto Action estiver definido como "evento criado por um trigger", e `operationtype` estiver definido como "script global", e `opcommand_hst` não estiver definido
opcommand_hst	array	Host para executar scripts globais. Os hosts devem ter a propriedade `hostid` definida. Comportamento da propriedade: - obrigatório se o `eventsource` do objeto Action estiver definido como "evento criado por um trigger", e `operationtype` estiver definido como "script global", e `opcommand_grp` não estiver definido
opmessage	object	Objeto contendo os dados sobre a mensagem enviada pela operação de recuperação. O objeto de mensagem da operação é descrito em detalhes acima. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "enviar mensagem"
opmessage_grp	array	Grupos de usuários para enviar mensagens. Os grupos de usuários devem ter a propriedade `usrgrpid` definida. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "enviar mensagem" e `opmessage_usr` não estiver definido
opmessage_usr	array	Usuários para enviar mensagens. Os usuários devem ter a propriedade `userid` definida. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "enviar mensagem" e `opmessage_grp` não estiver definido

Operação de atualização de ação

O objeto de operação de atualização de ação define uma operação que será realizada quando um problema for atualizado (comentado, reconhecido, severidade alterada ou fechado manualmente). As operações de atualização são possíveis apenas para ações de trigger e serviço. Possui as seguintes propriedades.

Propriedade	Tipo	Descrição
operationtype	integer	Tipo de operação. Valores possíveis: 0 - enviar mensagem; 1 - script global; 12 - notificar todos os envolvidos. Comportamento da propriedade: - obrigatório
opcommand	object	Script global a ser executado. O script global deve ter a propriedade `scriptid` definida. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "script global"
opcommand_grp	array	Grupos de hosts para executar scripts globais. Os grupos de hosts devem ter a propriedade `groupid` definida. Comportamento da propriedade: - obrigatório se `eventsource` do objeto Action estiver definido como "evento criado por um trigger", e `operationtype` estiver definido como "script global", e `opcommand_hst` não estiver definido
opcommand_hst	array	Host para executar scripts globais. Os hosts devem ter a propriedade `hostid` definida. Comportamento da propriedade: - obrigatório se `eventsource` do objeto Action estiver definido como "evento criado por um trigger", e `operationtype` estiver definido como "script global", e `opcommand_grp` não estiver definido
opmessage	object	Objeto contendo os dados sobre a mensagem enviada pela operação de atualização. O objeto de mensagem de operação é descrito em detalhes acima.
opmessage_grp	array	Grupos de usuários para enviar mensagens. Os grupos de usuários devem ter a propriedade `usrgrpid` definida. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "enviar mensagem" e `opmessage_usr` não estiver definido
opmessage_usr	array	Usuários para enviar mensagens. Os usuários devem ter a propriedade `userid` definida. Comportamento da propriedade: - obrigatório se `operationtype` estiver definido como "enviar mensagem" e `opmessage_grp` não estiver definido

Filtro de ação

O objeto de filtro de ação define um conjunto de condições que devem ser atendidas para executar as operações de ação configuradas. Ele possui as seguintes propriedades.

Propriedade	Tipo	Descrição
conditions	array	Conjunto de condições de filtro a serem usadas para filtrar resultados. As condições serão classificadas na ordem de sua colocação na fórmula. Comportamento da propriedade: - obrigatório
evaltype	integer	Método de avaliação da condição de filtro. Valores possíveis: 0 - e/ou; 1 - e; 2 - ou; 3 - expressão personalizada. Comportamento da propriedade: - obrigatório
eval_formula	string	Expressão gerada que será usada para avaliar as condições do filtro. A expressão contém IDs que referenciam condições de filtro específicas por seu `formulaid`. O valor de `eval_formula` é igual ao valor de `formula` para filtros com uma expressão personalizada. Comportamento da propriedade: - somente leitura
formula	string	Expressão definida pelo usuário a ser usada para avaliar as condições de filtros com uma expressão personalizada. A expressão deve conter IDs que referenciem condições de filtro específicas por seu `formulaid`. Os IDs usados na expressão devem corresponder exatamente aos definidos nas condições do filtro: nenhuma condição pode permanecer não utilizada ou omitida. Comportamento da propriedade: - obrigatório se `evaltype` estiver definido como "expressão personalizada"

Condição de filtro de ação

O objeto de condição de filtro de ação define uma condição específica que deve ser verificada antes de executar as operações da ação.

Propriedade	Tipo	Descrição
conditiontype	integer	Tipo de condição. Valores possíveis se `eventsource` do objeto Action estiver definido como "evento criado por um trigger": 0 - grupo de hosts; 1 - host; 2 - trigger; 3 - nome do evento; 4 - severidade do trigger; 6 - período de tempo; 13 - template de host; 16 - problema está suprimido; 25 - tag do evento; 26 - valor da tag do evento. Valores possíveis se `eventsource` do objeto Action estiver definido como "evento criado por uma regra de descoberta": 7 - IP do host; 8 - tipo de serviço descoberto; 9 - porta do serviço descoberto; 10 - status da descoberta; 11 - duração do tempo de atividade ou inatividade; 12 - valor recebido; 18 - regra de descoberta; 19 - verificação de descoberta; 20 - proxy; 21 - objeto de descoberta. Valores possíveis se `eventsource` do objeto Action estiver definido como "evento criado por autoregistro de agent ativo": 20 - proxy; 22 - nome do host; 24 - metadados do host. Valores possíveis se `eventsource` do objeto Action estiver definido como "evento interno": 0 - grupo de hosts; 1 - host; 13 - template de host; 23 - tipo de evento; 25 - tag do evento; 26 - valor da tag do evento. Valores possíveis se `eventsource` do objeto Action estiver definido como "evento criado na atualização do status do serviço": 25 - tag do evento; 26 - valor da tag do evento; 27 - serviço; 28 - nome do serviço. Comportamento da propriedade: - obrigatório
value	string	Valor para comparar. Comportamento da propriedade: - obrigatório
value2	string	Valor secundário para comparar. Comportamento da propriedade: - obrigatório se `eventsource` do objeto Action estiver definido como "evento criado por um trigger", `conditiontype` estiver definido como qualquer valor possível para ações de trigger, e o tipo de condição (veja abaixo) for "26" - obrigatório se `eventsource` do objeto Action estiver definido como "evento interno", `conditiontype` estiver definido como qualquer valor possível para ações internas, e o tipo de condição (veja abaixo) for "26" - obrigatório se `eventsource` do objeto Action estiver definido como "evento criado na atualização do status do serviço", `conditiontype` estiver definido como qualquer valor possível para ações de serviço, e o tipo de condição (veja abaixo) for "26"
formulaid	string	ID único arbitrário que é usado para referenciar a condição a partir de uma expressão personalizada. Só pode conter letras maiúsculas. O ID deve ser definido pelo usuário ao modificar as condições do filtro, mas será gerado novamente ao solicitá-las posteriormente.
operator	integer	Operador da condição. Valores possíveis: 0 - (padrão) igual; 1 - diferente; 2 - contém; 3 - não contém; 4 - em; 5 - maior ou igual; 6 - menor ou igual; 7 - não está em; 8 - corresponde; 9 - não corresponde; 10 - Sim; 11 - Não.

Para entender melhor como usar filtros com vários tipos de expressões, veja exemplos nas páginas dos métodos action.get e action.create.

Os seguintes operadores e valores são suportados para cada tipo de condição.

Condição	Nome da condição	Operadores suportados	Valor esperado
0	Grupo de hosts	igual, diferente	ID do grupo de hosts.
1	Host	igual, diferente	ID do host.
2	Trigger	igual, diferente	ID do trigger.
3	Nome do evento	contém, não contém	Nome do evento.
4	Severidade do trigger	igual, diferente, maior ou igual, menor ou igual	Severidade do trigger. Consulte a propriedade `severity` do trigger para uma lista de severidades de trigger suportadas.
5	Valor do trigger	igual	Valor do trigger. Consulte a propriedade `value` do trigger para uma lista de valores de trigger suportados.
6	Período de tempo	em, não está em	Momento em que o evento foi disparado como um período de tempo.
7	IP do host	igual, diferente	Um ou vários intervalos de IP para verificar, separados por vírgulas. Consulte a seção configuração de descoberta de rede para mais informações sobre os formatos suportados de intervalos de IP.
8	Tipo de serviço descoberto	igual, diferente	Tipo de serviço descoberto. O tipo de serviço corresponde ao tipo da verificação de descoberta usada para detectar o serviço. Consulte a propriedade `type` da verificação de descoberta para uma lista de tipos suportados.
9	Porta do serviço descoberto	igual, diferente	Uma ou várias faixas de portas, separadas por vírgulas.
10	Status da descoberta	igual	Status de um objeto descoberto. Valores possíveis: 0 - host ou serviço ativo; 1 - host ou serviço inativo; 2 - host ou serviço descoberto; 3 - host ou serviço perdido.
11	Duração do tempo de atividade ou inatividade	maior ou igual, menor ou igual	Tempo indicando há quanto tempo o objeto descoberto está no status atual em segundos.
12	Valores recebidos	igual, diferente, maior ou igual, menor ou igual, contém, não contém	Valor retornado ao executar uma verificação de descoberta Zabbix agent, SNMPv1, SNMPv2 ou SNMPv3.
13	Template de host	igual, diferente	ID do template vinculado.
16	Problema está suprimido	Sim, Não	Nenhum valor necessário: usar o operador "Sim" significa que o problema deve ser suprimido, "Não" - não suprimido.
18	Regra de descoberta	igual, diferente	ID da regra de descoberta.
19	Verificação de descoberta	igual, diferente	ID da verificação de descoberta.
20	Proxy	igual, diferente	ID do proxy.
21	Objeto de descoberta	igual	Tipo de objeto que disparou o evento de descoberta. Valores possíveis: 1 - host descoberto; 2 - serviço descoberto.
22	Nome do host	contém, não contém, corresponde, não corresponde	Nome do host. O uso de uma expressão regular é suportado para os operadores corresponde e não corresponde em condições de autoregistro.
23	Tipo de evento	igual	Evento interno específico. Valores possíveis: 0 - item em estado "não suportado"; 1 - item em estado "normal"; 2 - regra LLD em estado "não suportado"; 3 - regra LLD em estado "normal"; 4 - trigger em estado "desconhecido"; 5 - trigger em estado "normal".
24	Metadados do host	contém, não contém, corresponde, não corresponde	Metadados do host autoregistrado. O uso de uma expressão regular é suportado para os operadores corresponde e não corresponde.
25	Tag	igual, diferente, contém, não contém	Tag do evento.
26	Valor da tag	igual, diferente, contém, não contém	Valor da tag do evento.
27	Serviço	igual, diferente	ID do serviço.
28	Nome do serviço	igual, diferente	Nome do serviço.

Documentation