Esta é uma tradução da página de documentação original em inglês. Ajude-nos a torná-la melhor.

Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

> Objeto de ação

Os objetos a seguir estão diretamente relacionados à API action.

Ação

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

|Propriedade|Tipo|Descrição| |--------|---------------------------------------- -----------|-----------| |actionid|string|(readonly) ID da ação.| |esc_period
(obrigatório)|string|Duração padrão da etapa de operação. Deve ter pelo menos 60 segundos. Aceita segundos, unidade de tempo com sufixo e macro do usuário.

Observe que os escalonamentos são suportados apenas para ações de gatilho, internas e de serviço e apenas em operações normais.| |eventsource
(obrigatório)|inteiro|(constante) Tipo de eventos que a ação manipulará.

Consulte a propriedade event "source" para obter uma lista de tipos de eventos suportados.| |nome
(obrigatório)|string|Nome da ação.| |status|inteiro|Se a ação está habilitada ou desabilitada.

Valores possíveis:
0 - (padrão) habilitado;
1 - desabilitado.| |pause_suppressed|integer|Pausa ou não o escalonamento durante os períodos de manutenção.

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

Observe que este parâmetro é válido apenas para ações de gatilho.| |notify_if_canceled|integer|Se notificar quando o encaminhamento for cancelado.

Valores possíveis:
0 - Não notificar quando o encaminhamento for cancelado;
1 - (padrão) Notificar quando o escalonamento for cancelado.

Observe que este parâmetro é válido apenas para ações de gatilho.|

Operação de ação

O objeto de operação de ação define uma operação que será executada quando uma ação é executada. Tem as seguintes propriedades.

|Propriedade|Tipo|Descrição| |--------|---------------------------------------- -----------|-----------| |operationid|string|(readonly) ID da operação de ação.| |operationtype
(obrigatório)|inteiro|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 ao modelo;
7 - desvincular do modelo;
>8 - habilita o host;
9 - desabilita o host;
10 - define o modo de inventário do host.

Observe que apenas os tipos '0' e '1' são suportados para ações de acionador e serviço, apenas '0' é suportado para ações internas. Todos os tipos têm suporte para ações de descoberta e registro automático.| |actionid|string|(readonly) ID da ação à qual a operação pertence.| |esc_period|string|Duração de uma etapa de escalação em segundos. Deve ser superior a 60 segundos. Aceita segundos, unidade de tempo com sufixo e macro de usuário. Se definido como 0 ou 0s, o período de escalonamento de ação padrão será usado.

Padrão: 0s.

Observe que os escalonamentos são suportados apenas para ações de gatilho, internas e de serviço, e apenas em condições normais operações.| |esc_step_from|integer|Etapa para iniciar o escalonamento.

Padrão: 1.

Observe que os escalonamentos são suportados apenas para ações de gatilho, internas e de serviço, e apenas em condições normais operações.| |esc_step_to|integer|Passo para encerrar o escalonamento em.

Padrão: 1.

Observe que os escalonamentos são suportados apenas para ações de gatilho, internas e de serviço, e apenas em operações normais .| |evaltype|integer|Método de avaliação da condição de operação.

Valores possíveis:
0 - (padrão) AND / OR;
1 - AND;
2 - OR.| |opcommand|object|Objeto contendo dados no script global executado pela operação.

Cada objeto tem uma propriedade a seguir: scriptid - (string) ID do script.

Obrigatório para operações globais de script.| |opcommand_grp|array|Grupos de hosts para executar scripts globais.

Cada objeto tem as seguintes propriedades:
opcommand_grpid - (string, readonly) ID do objeto;
operationid - (string, readonly) ID da operação;
groupid - (string) ID do grupo de hosts.

Obrigatório para operações globais de script se opcommand_hst for não definido.| |opcommand_hst|array|Host para executar scripts globais.

Cada objeto tem as seguintes propriedades:
opcommand_hstid - (string, readonly) ID do objeto;
operationid - (string, readonly) ID da operação;
hostid - (string) ID do host; se definido como 0, o comando será executado no host atual.

Requerido para operações globais de script se opcommand_grp não estiver definido.| |opconditions|array|Condições de operação usadas para ações de gatilho.

O objeto de condição de operação é descrito em detalhes abaixo.| |opgroup|array|Grupos de hosts aos quais adicionar hosts.

Cada objeto tem as seguintes propriedades:
operationid - (string, readonly) ID da operação;
groupid - (string) ID do grupo de hosts.

Obrigatório para as operações "adicionar ao grupo de hosts" e "remover do grupo de hosts".| |opmessage|object|Objeto contendo os dados sobre a mensagem enviada pela operação.

O objeto mensagem da operação é descrito em detalhes abaixo.< br>
Requerido para operações de mensagens.| |opmessage_grp|array|Grupos de usuários para os quais enviar mensagens.

Cada objeto tem as seguintes propriedades:
operationid - (string, readonly) ID da operação;
usrgrpid - (string) ID do grupo de usuários.

Requerido para operações de mensagem se opmessage_usr não estiver definido.| |opmessage_usr|array|Usuários para quem enviar mensagens.

Cada objeto tem as seguintes propriedades:
operationid - (string, readonly) ID da operação;
userid - (string) ID do usuário.

Obrigatório para operações de mensagem se opmessage_grp não estiver definido.| |optemplate|array|Modelos aos quais vincular os hosts.

Cada objeto tem as seguintes propriedades:
operationid - (string, readonly) ID da operação;
templateid - (string) ID do modelo.

Obrigatório para as operações "vincular ao modelo" e "desvincular do modelo".| |opinventory|object|Modo de inventário definido como host.

O objeto tem as seguintes propriedades:
operationid - (string, readonly) ID da operação;
inventory_mode - * (string)* Modo de inventário.

Obrigatório para as operações "Definir modo de inventário do host".|

Mensagem de operação de ação

O objeto de mensagem de operação contém dados sobre a mensagem que ser enviado pela operação.

|Propriedade|Tipo|Descrição| |--------|---------------------------------------- -----------|-----------| |default_msg|integer|Se usar o texto e o assunto da mensagem de ação padrão.

Valores possíveis:
0 - usar os dados da operação;
1 - (padrão) usar os dados do tipo de mídia.| |mediatypeid|string|ID do tipo de mídia que será usado para enviar a mensagem.| |message|string|Texto da mensagem da operação.| |assunto|string|Assunto da mensagem da operação.|

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

O objeto de condição de operação de ação define uma condição que deve ser atendidas para realizar a operação atual. Tem as seguintes propriedades.

|Propriedade|Tipo|Descrição| |--------|---------------------------------------- -----------|-----------| |opconditionid|string|(readonly) ID da condição de operação da ação| |conditiontype
(obrigatório)|inteiro|Tipo de condição.

Valores possíveis:
14 - evento reconhecido.| |valor
(obrigatório)|string|Valor para comparar.| |operationid|string|(readonly) ID da operação.| |operador|inteiro|Operador de condição.

Valores possíveis:
0 - (padrão) =.|

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

|Condição|Nome da condição|Operadores suportados|Valor esperado| |---------|--------------|-------------------|---- ----------| |14|Evento reconhecido|=|Se o evento é 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á executado quando um problema é resolvido. As operações de recuperação são possíveis para ações de gatilho, internas e de serviço. Tem o seguinte propriedades.

|Propriedade|Tipo|Descrição| |--------|---------------------------------------- -----------|-----------| |operationid|string|(readonly) ID da operação de ação.| |operationtype
(obrigatório)|inteiro|Tipo de operação.

Possíveis valores para ações de trigger e serviço:
0 - enviar mensagem;
1 - script global;< br>11 - notificar todos os envolvidos.

Possíveis valores para ações internas:
0 - enviar mensagem;
11 - notificar todos os envolvidos.| |actionid|string|(readonly) ID da ação à qual a operação de recuperação pertence.| |opcommand|object|Objeto contendo dados no script de tipo de ação global executado pela operação.

Cada objeto tem uma propriedade a seguir: scriptid - (string) ID do script de tipo de ação.

Requerido para operações globais de script.| |opcommand_grp|array|Grupos de hosts para executar scripts globais.

Cada objeto tem as seguintes propriedades:
opcommand_grpid - (string, readonly) ID do objeto;
operationid - (string, readonly) ID da operação;
groupid - (string) ID do grupo de hosts.

Obrigatório para operações globais de script se opcommand_hst for não definido.| |opcommand_hst|array|Host para executar scripts globais.

Cada objeto tem as seguintes propriedades:
opcommand_hstid - (string, readonly) ID do objeto;
operationid - (string, readonly) ID da operação;
hostid - (string) ID do host; se definido como 0, o comando será executado no host atual.

Requerido para operações globais de script se opcommand_grp não estiver definido.| |opmessage|object|Objeto contendo os dados sobre a mensagem enviada pela operação de recuperação.

O objeto mensagem da operação é descrito em detalhes acima.

Requerido para operações de mensagens.| |opmessage_grp|array|Grupos de usuários para os quais enviar mensagens.

Cada objeto tem as seguintes propriedades:
operationid - (string, readonly) ID da operação;
usrgrpid - (string) ID do grupo de usuários.

Requerido para operações de mensagem se opmessage_usr não estiver definido.| |opmessage_usr|array|Usuários para os quais enviar mensagens.

Cada objeto tem as seguintes propriedades:
operationid - (string, readonly) ID da operação;
userid - (string) ID do usuário.

Obrigatório para operações de mensagem se 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 é atualizado (comentado, reconhecido, gravidade alterada ou fechada manualmente). Operações de atualização são possíveis para ações de gatilho e serviço. Tem as seguintes propriedades.

|Propriedade|Tipo|Descrição| |--------|---------------------------------------- -----------|-----------| |operationid|string|(readonly) ID da operação de ação.| |operationtype
(obrigatório)|inteiro|Tipo de operação.

Possíveis valores para ações de trigger e serviço:
0 - enviar mensagem;
1 - script global;< br>12 - notifique todos os envolvidos.| |opcommand|object|Objeto contendo dados no script do tipo de ação global executado pela operação.

Cada objeto tem uma propriedade a seguir: scriptid - (string) ID do script do tipo de ação.

Necessário para operações globais de script.| |opcommand_grp|array|Grupos de hosts para executar scripts globais.

Cada objeto tem as seguintes propriedades:
groupid - (string) ID do grupo de hosts.
< br>Requerido para operações de script global se opcommand_hst não estiver definido.| |opcommand_hst|array|Host para executar scripts globais.

Cada objeto tem as seguintes propriedades:
hostid - (string) ID do host; se definido como 0, o comando será executado no host atual.

Requerido para operações globais de script se 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 da operação é descrito em detalhes acima. | |opmessage_grp|array|Grupos de usuários para os quais enviar mensagens.

Cada objeto tem as seguintes propriedades:
usrgrpid - (string) ID do grupo de usuários.
<br >Requerido apenas para operações send message se opmessage_usr não estiver definido.
É ignorado para operações send update message.| |opmessage_usr|array|Usuários para os quais enviar mensagens.

Cada objeto tem as seguintes propriedades:
userid - (string) ID do usuário.

Obrigatório somente para operações send message se opmessage_grp não estiver definido.
É ignorado para operações send update message.|

Filtro de ação

O objeto de filtro de ação define um conjunto de condições que devem ser atendidas para execute as operações de ação configuradas. Tem o seguinte propriedades.

|Propriedade|Tipo|Descrição| |--------|---------------------------------------- -----------|-----------| |condições
(obrigatório)|array|Conjunto de condições de filtro a serem usadas para filtrar resultados.| |evaltype
(obrigatório)|inteiro|Método de avaliação da condição do filtro.

Valores possíveis:
0 - e/ou;
1 - e;
2 - ou;
3 - expressão personalizada.| |eval_formula|string|(readonly) Expressão gerada que será utilizada 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.| |formula|string|Expressão definida pelo usuário a ser usada para avaliar condições de filtros com uma expressão customizada. A expressão deve conter IDs que façam 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 sem uso ou omitida.

Obrigatório para filtros de expressão personalizados.|

Condição do filtro de ação

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

|Propriedade|Tipo|Descrição| |--------|---------------------------------------- -----------|-----------| |conditionid|string|(readonly) ID da condição da ação.| |conditiontype
(obrigatório)|inteiro|Tipo de condição.

Valores possíveis para ações de gatilho:
0 - grupo de hosts;
1 - host;
2 - gatilho;
3 - nome do gatilho;
4 - gravidade do gatilho;
6 - período de tempo;
13 - modelo de host;
16 - problema suprimido;
25 - evento tag;
26 - valor da tag de evento.

Valores possíveis para ações de descoberta:
7 - IP do host;
8 - tipo de serviço descoberto;
9 - porta de serviço descoberta;< br>10 - status da descoberta;
11 - duração do tempo de atividade ou do tempo de inatividade;
12 - valor recebido;
18 - regra de descoberta;
19 - verificação de descoberta;
20 - proxy;
>21 - objeto de descoberta.

Valores possíveis para ações de registro automático:
20 - proxy;
22 - nome do host;
24 - metadados do host.

Valores possíveis para ações internas:
0 - grupo de host;
1 - host;
13 - modelo de host;
23 - tipo de evento;
25 - tag de evento;
26 - valor da tag de evento .

Valores possíveis para ações de serviço:
25 - tag de evento;
26 - valor da tag de evento;
27 - serviço;<br >28 - nome do serviço.| |valor
(obrigatório)|string|Valor para comparar.| |value2
|string|Valor secundário para comparar. Necessário para ações de gatilho, internas e de serviço quando o tipo de condição é 26.| |actionid|string|(readonly) ID da ação à qual a condição pertence.| |formulaid|string|ID exclusivo arbitrário que é usado para fazer referência à condição de uma expressão customizada. 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á-los posteriormente.| |operator|inteiro|Operador de condição.

Valores possíveis:
0 - (padrão) é igual;
1 - não é igual;
2 - contém;
3 - não contém;
4 - em;
5 - é maior ou igual;
6 - é menor ou igual;
7 - não em;
8 - corresponde;<br >9 - não corresponde;
10 - Sim;
11 - Não.|

Para entender melhor como usar filtros com vários tipos de expressões, veja exemplos no action.get e método action.create Páginas.

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

|Condição|Nome da condição|Operadores suportados|Valor esperado| |---------|--------------|-------------------|---- ----------| |0|Grupo de hosts|igual,
diferente|ID do grupo de hosts.| |1|Host|igual,
não é igual|Host ID.| |2|Trigger|igual,
diferente|Trigger ID.| |3|Nome do gatilho|contém,
não contém|Nome do gatilho.| |4|Gravidade do gatilho|igual,
diferente,
é maior ou igual,
é menor ou igual|Gravidade do gatilho. Consulte a propriedade "severity" do gatilho para obter uma lista de gravidades de gatilho compatíveis.| |5|Valor do gatilho|igual|Valor do gatilho. Consulte a propriedade "valor" do gatilho para obter uma lista de valores de gatilho compatíveis.| |6|Período de tempo|em, não em|Tempo em que o evento foi acionado como um período de tempo.| |7|IP do host|igual,
não é igual|Um ou vários intervalos de IP para verificar separados por vírgulas. Consulte a seção configuração de descoberta de rede para obter mais informações sobre os formatos suportados de intervalos de IP.| |8|Tipo de serviço descoberto|igual,
não é igual|Tipo de serviço descoberto. O tipo de serviço corresponde ao tipo de verificação de descoberta usado para detectar o serviço. Consulte a propriedade de "tipo" de verificação de descoberta para obter uma lista de tipos suportados.| |9|Porta de serviço descoberta|igual,
não é igual|Um ou vários intervalos de portas separados por vírgulas.| |10|Status de descoberta|igual|Status de um objeto descoberto.

Valores possíveis:
0 - host ou serviço ativo;
1 - host ou serviço desativado;
2 - host ou serviço descoberto;
3 - host ou serviço perdido.| |11|A duração do tempo de atividade ou inatividade|é maior ou igual,
é menor ou igual|Tempo que indica 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 realizar um Verificação de descoberta do agente Zabbix, SNMPv1, SNMPv2 ou SNMPv3.| |13|Modelo do host|igual,
não é igual|ID do modelo vinculado.| |16|O problema foi 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,
não é igual|ID da regra de descoberta.| |19|Verificação de descoberta|igual,
não é igual|ID da verificação de descoberta.| |20|Proxy|igual,
diferente|ID do proxy.| |21|Objeto de descoberta|igual|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 em condições de registro automático.| |23|Tipo de evento|igual|Evento interno específico.

Valores possíveis:
0 - item no estado "não suportado";
1 - item no estado "normal";
2 - Regra LLD em estado "não suportado";
3 - Regra LLD em estado "normal";
4 - acionador em estado "desconhecido";
5 - acionador em 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,
diferente,
contém,
não contém|Etiqueta de evento.| |26|Valor da tag|igual,
não é igual,
contém,
não contém|Valor da tag do evento.| |27|Serviço|é igual,
não é igual a|ID do serviço.| |28|Nome do serviço|igual,
não é igual|Nome do serviço.|