Objeto action

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

Ação

O objeto de ação tem as seguintes propriedades.

Propriedade Tipo Descrição
actionid ID ID da ação.

Comportamento da propriedade:
- somente leitura
- obrigatória para operações de atualização
esc_period string Duração padrão da etapa da operação. Deve ser de pelo menos 60 segundos. Aceita um número de segundos (por exemplo, 60, 300), um valor com um sufixo de tempo (por exemplo, 30s, 1m, 2h) ou uma macro de usuário.

Comportamento da propriedade:
- suportada 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 tratará.

Consulte a propriedade source do evento para obter uma lista dos tipos de eventos compatíveis.

Comportamento da propriedade:
- constante
- obrigatória para operações de criação
name string Nome da ação.

Comportamento da propriedade:
- obrigatória para operações de criação
status integer Indica se a ação está habilitada ou desabilitada.

Valores possíveis:
0 - (padrão) habilitada;
1 - desabilitada.
pause_symptoms integer Indica se a escalação deve ser pausada quando o evento for um evento de sintoma.

Valores possíveis:
0 - Não pausar a escalação para problemas de sintoma;
1 - (padrão) Pausar a escalação para problemas de sintoma.

Comportamento da propriedade:
- suportada se eventsource estiver definido como "evento criado por um trigger"
pause_suppressed integer Indica se a escalação deve ser pausada durante períodos de manutenção.

Valores possíveis:
0 - Não pausar a escalação;
1 - (padrão) Pausar a escalação.

Comportamento da propriedade:
- suportada se eventsource estiver definido como "evento criado por um trigger"
notify_if_canceled integer Indica se uma notificação deve ser enviada quando a escalação for cancelada.

Valores possíveis:
0 - Não enviar uma notificação quando a escalação for cancelada;
1 - (padrão) Enviar uma notificação quando a escalação for cancelada.

Comportamento da propriedade:
- suportada se eventsource estiver definido como "evento criado por um trigger"

Operação da ação

O objeto de operação da ação define uma operação que será realizada quando uma ação for executada. Ele tem 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 o modo de inventário do host;
13 - adicionar tags ao host;
14 - remover tags do 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 uma etapa de escalonamento em segundos. Deve ser superior a 60 segundos. Aceita um número de segundos (por exemplo, 60, 300), um valor com um sufixo de tempo (por exemplo, 30s, 1m, 2h) 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:
- compatível 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 Etapa a partir da qual o escalonamento deve começar.

Padrão: 1.

Comportamento da propriedade:
- compatível 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 Etapa na qual o escalonamento deve terminar.

Padrão: 1.

Comportamento da propriedade:
- compatível 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 das condições 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 nos quais os scripts globais serão executados.

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 no qual os scripts globais serão executados.

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 da operação usadas para ações de trigger.

O objeto de condição da operação é descrito em detalhes abaixo.
opgroup array Grupos de hosts aos quais os hosts serão adicionados.

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 que contém os dados sobre a mensagem enviada pela operação.

O objeto de mensagem da 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 os quais as mensagens serão enviadas.

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 os quais as mensagens serão enviadas.

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 a serem vinculados 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 a ser definido no host.

O inventário deve ter a propriedade inventory_mode definida.

Comportamento da propriedade:
- obrigatório se operationtype estiver definido como "definir o modo de inventário do host"
optag array Tags do host a serem adicionadas ou removidas.

As tags devem ter a propriedade tag definida.
A propriedade value é opcional.

Comportamento da propriedade:
- compatível se operationtype estiver definido como "adicionar tags ao host" ou "remover tags do 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. Ele 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 para comparar.

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 de 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á executada 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 de 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 do 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 fazem referência a 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 fazem referência a 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 do filtro da ação

O objeto de condição do filtro da ação define uma condição específica que deve ser verificada antes da execução das 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 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 descoberto;
29 - grupo de proxies.

Valores possíveis se eventsource do objeto Action estiver definido como "evento criado pelo registro automático de agent ativo":
20 - proxy;
22 - nome do host;
24 - metadados do host;
29 - grupo de proxies.

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 a ser comparado.

Comportamento da propriedade:
- obrigatório
value2 string Valor secundário a ser comparado.

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 exclusivo arbitrário usado para referenciar a condição em uma expressão personalizada. Pode conter apenas 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 a;
1 - não é igual a;
2 - contém;
3 - não contém;
4 - está em;
5 - é maior ou igual a;
6 - é menor ou igual a;
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, consulte os exemplos nas páginas dos métodos action.get e action.create.

Os operadores e valores a seguir são compatíveis com cada tipo de condição.

Condição Nome da condição Operadores compatíveis Valor esperado
0 Grupo de hosts é igual a,
não é igual a		 ID do grupo de hosts.
1 Host é igual a,
não é igual a		 ID do host.
2 Trigger é igual a,
não é igual a		 ID do trigger.
3 Nome do evento contém,
não contém		 Nome do evento.
4 Severidade do trigger é igual a,
não é igual a,
é maior ou igual a,
é menor ou igual a		 Severidade do trigger. Consulte a propriedade severity do trigger para obter uma lista das severidades de trigger compatíveis.
5 Valor do trigger é igual a Valor do trigger. Consulte a propriedade value do trigger para obter uma lista dos valores de trigger compatíveis.
6 Período de tempo está em, não está em Momento em que o evento foi acionado, como um período de tempo.
7 IP do host é igual a,
não é igual a		 Um ou vários intervalos de IP a serem verificados, separados por vírgulas. Consulte a seção configuração da descoberta de rede para obter mais informações sobre os formatos compatíveis de intervalos de IP.
8 Tipo de serviço descoberto é igual a,
não é igual a		 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 obter uma lista dos tipos compatíveis.
9 Porta do serviço descoberto é igual a,
não é igual a		 Um ou vários intervalos de portas, separados por vírgulas.
10 Status da descoberta é igual a 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 a,
é menor ou igual a		 Tempo que indica há quantos segundos o objeto descoberto está no status atual.
12 Valores recebidos é igual a,
não é igual a,
é maior ou igual a,
é menor ou igual a,
contém,
não contém		 Valor retornado ao executar uma verificação de descoberta de Zabbix agent, SNMPv1, SNMPv2 ou SNMPv3.
13 Template de host é igual a,
não é igual a		 ID do template vinculado.
16 Problema suprimido Sim, Não Nenhum valor é necessário: usar o operador "Sim" significa que o problema deve ser suprimido; "Não" significa que não deve ser suprimido.
18 Regra de descoberta é igual a,
não é igual a		 ID da regra de descoberta.
19 Verificação de descoberta é igual a,
não é igual a		 ID da verificação de descoberta.
20 Proxy é igual a,
não é igual a		 ID do proxy.
21 Objeto descoberto é igual a Tipo de objeto que acionou 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 é compatível com os operadores corresponde e não corresponde nas condições de registro automático.
23 Tipo de evento é igual a Evento interno específico.

Valores possíveis:
0 - item no estado "não suportado";
1 - item no estado "normal";
2 - regra LLD no estado "não suportado";
3 - regra LLD no estado "normal";
4 - trigger no estado "desconhecido";
5 - trigger no estado "normal".
24 Metadados do host contém,
não contém,
corresponde,
não corresponde		 Metadados do host registrado automaticamente.
O uso de uma expressão regular é compatível com os operadores corresponde e não corresponde.
25 Tag é igual a,
não é igual a,
contém,
não contém		 Tag do evento.
26 Valor da tag é igual a,
não é igual a,
contém,
não contém		 Valor da tag do evento.
27 Serviço é igual a,
não é igual a		 ID do serviço.
28 Nome do serviço é igual a,
não é igual a		 Nome do serviço.
29 Grupo de proxies é igual a,
não é igual a		 ID do grupo de proxies.