Table of Contents

> Objeto Action

FIXME This page is not fully translated, yet. Please help completing the translation.
(remove this paragraph once the translation is finished)

> Objeto Action

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

Action

O objeto action tem as seguintes propriedades.

Propriedade	Tipo	Descrição
actionid	string	(somente leitura) ID da ação.
esc_period (requerido)	integer	Duração padrão do passo da operação. Deve ser maior que 60 segundos.
eventsource (requerido)	integer	(constante) Tipos de eventos que a ação vai manipular. Verifique a propriedade "source" do evento para uma lista de tipos de eventos suportados.
name (requerido)	string	Nome da ação
def_longdata	string	Texto da mensagem informando a existência de problema.
def_shortdata	string	Assunto da mensagem informando a existência de problema.
r_longdata	string	Texto da mensagem de recuperação.
r_shortdata	string	Assunto da mensagem de recuperação.
recovery_msg	integer	Indica se as mensagens de recuperação estão habilitadas. Valores possíveis: 0 - (padrão) desabilitadas 1 - habilitadas
status	integer	Indica se a action está habilitada ou desabilitada. Valores possíveis: 0 - (padrão) habilitada 1 - desabilitada

Action operation

O objeto action operation define uma operação que será realizada quando uma ação for executada. Ela tem as propriedades definidas na tabela a seguir:

Propriedade	Tipo	Descrição
operationid	string	(somente leitura) ID da operação de ação
operationtype (requerido)	integer	Tipo da operação. Valores possíveis: 0 - enviar mensagem; 1 - comando remoto; 2 - adicionar host; 3 - remover host; 4 - adicionar a grupo de hosts; 5 - remove de grupo de hosts; 6 - associar a template; 7 - desassociar de template; 8 - habilitar host; 9 - desabilitar host.
actionid	string	ID da ação à qual a operação pertence.
esc_period	integer	Duração de um passo de escalonamento em segundos. Deve ser maior que 60 segundos. Se definido como 0, o período padrão de escalonamento da ação será usado. Padrão: 0
esc_step_from	integer	Passo a partir do qual realizar o escalonamento. Padrão: 1
esc_step_to	integer	Passo no qual parar o escalonamento. Padrão: 1
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	Objeto contendo os dados sobre o comando executado pela operação. O objeto operation command está descrito em detalhes abaixo. Requerido para operações "comando remoto".
opcommand_grp	array	Grupos de hosts onde executar comandos remotos. Cada objeto tem as seguintes propriedades: `opcommand_grpid` - (string, somente leitura) ID do objeto; `operationid` - (string) ID da operação; `groupid` - (string) ID do grupo de hosts. Requerido para operações "comando remoto" se `opcommand_hst` não estiver definido.
opcommand_hst	array	Host no qual executar comandos remotos. Cada objeto tem as seguintes propriedades: `opcommand_hstid` - (string, somente leitura) ID do objeto; `operationid` - (string) ID da operação; `hostid` - (string) ID do host; se definido como 0 o comando será executado no host atual. Requirido para operações "comando remoto" se `opcommand_grp` não estiver definido.
opconditions	array	Condições da operação usados para ações de triggers. O objeto condição da operação está descrito em detalhes abaixo.
opgroup	array	Grups de hosts nos quais adicionar hosts. Cada objeto tem as seguintes propriedades: `operationid` - (string) ID da operação; `groupid` - (string) ID do grupo de host. Requerido para operações "adicioanar a grupo de host" e "remover de grupo de hosts".
opmessage	object	Objeto contendo os dados sabre a mensagem enviada pela operação. O objeto mensagem da operação descrito em detalhes abaixo. Requerido para operações de mensagens.
opmessage_grp	array	Grupos de usuários para os quais mandar mensagens. Cada objeto tem as seguintes propriedades: `operationid` - (string) 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 mandar mensagens. Cada objeto tem as seguintes propriedades: `operationid` - (string) ID da operação; `userid` - (string) ID do usuário. Requerido para operações de mensagem se `opmessage_grp` não estiver definido.
optemplate	array	Templates aos quais associar os hosts. Cada objeto tem as seguintes propriedades: `operationid` - (string) ID da operação; `templateid` - (string) ID do template. Requerido para operações "associar a template" e "desassociar de template".

Comando operação da ação

O objeto comando da operação contém dados sobre o comando que será executado pela operação.

Propriedade	Tipo	Descrição
operationid	string	(somente leitura) ID da operação
command (requerido)	string	Comando a ser executado.
type (requerido)	integer	Tipo do comando da operação. Valores possíveis: 0 - script customizado; 1 - IPMI; 2 - SSH; 3 - Telnet; 4 - script global.
authtype	integer	Método de autenticação usado para comandos SSH. Valores possíveis: 0 - senha; 1 - chave pública. Requerido para comandos SSH.
execute_on	integer	Alvo no qual será executado o script customizado. Valores possíveis: 0 - Zabbix agent; 1 - Zabbix server. Requerido para comandos de script customizados.
password	string	Senha usada para comandos SSH com autenticação de senha e comandos Telnet.
port	string	Número da porta usada para comandos SSH e Telnet..
privatekey	string	Nome do arquivo com a chave privada usado para comandos SSH com autenticação usando chave pública. Requerido para comandos SSH com autenticação utilizando chave pública.
publickey	string	Nome do arquivo com a chave pública usado para comandos SSH com autenticação usando chave pública. Requerido para comandos SSH com autenticação utilizando chave pública.
scriptid	string	ID do script usado par comandos globais de script. Requerido para comandos de scripts globais.
username	string	Username utilizado para autenticação. Requerido para comandos SSH e Telnet.

Action operation message

The operation message object contains data about the message that will be sent by the operation.

Propriedade	Tipo	Descrição
operationid	string	(somente leitura) ID da operação da ação.
default_msg	integer	Indica se serão usados os texto e assunto padrões da ação. Valores possíveis: 0 - (default) usar dados da operação; 1 - usar dados da ação.
mediatypeid	string	ID do tipo de mídia que será usada para enviar a mensagem.
message	string	Texto da mensagem da operação.
subject	string	Assunto da mensagem da operação.

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

O objetivo condição da operação de ação define uma condição que precisa ser satisfeita para realização da operação corrente. Tem as seguintes propriedades:

Propriedade	Tipo	Descrição
opconditionid	string	(somente leitura) ID da condição da operação de ação
conditiontype (requerido)	integer	Tipo de condição Valores possíveis: 14 - evento reconhecido.
value (requerido)	string	Valor com o qual realizar a comparação.
operationid	string	(somente leitura) ID da operação.
operator	integer	Condition operator. Valores possíveis: 0 - (padrão) =.

The following operators and values are supported for each operation condition type.

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

Filtro de ação

The action filter object defines a set of conditions that must be met to perform the configured action operations. It has the following properties.

Property	Type	Description
conditions (requerido)	array	Set of filter conditions to use for filtering results.
evaltype (requerido)	integer	Filter condition evaluation method. Valores possíveis: 0 - and/or; 1 - and; 2 - or; 3 - custom expression.
eval_formula	string	(somente leitura) Generated expression that will be used for evaluating filter conditions. The expression contains IDs that reference specific filter conditions by its `formulaid`. The value of `eval_formula` is equal to the value of `formula` for filters with a custom expression.
formula	string	User-defined expression to be used for evaluating conditions of filters with a custom expression. The expression must contain IDs that reference specific filter conditions by its `formulaid`. The IDs used in the expression must exactly match the ones defined in the filter conditions: no condition can remain unused or omitted. Required for custom expression filters.

Action filter condition

The action filter condition object defines a specific condition that must be checked before running the action operations.

Property	Type	Description
conditionid	string	(somente leitura) ID of the action condition.
conditiontype (requerido)	integer	Type of condition. \\Valores possíveis para ações de triggers: 0 - host group; 1 - host; 2 - trigger; 3 - trigger name; 4 - trigger severity; 5 - trigger value; 6 - time period; 13 - host template; 15 - application; 16 - maintenance status. Valores possíveis para ações de descoberta: 7 - host IP; 8 - discovered service type; 9 - discovered service port; 10 - discovery status; 11 - uptime or downtime duration; 12 - received value; 18 - discovery rule; 19 - discovery check; 20 - proxy; 21 - discovery object. Valores possíveis para ações de auto-registro: 20 - proxy; 22 - host name; 24 - host metadata. Valores possíveis para ações internas: 0 - host group; 1 - host; 13 - host template; 15 - application; 23 - event type.
value (requerido)	string	Value to compare with.
actionid	string	(somente leitura) ID of the action that the condition belongs to.
formulaid	string	Arbitrary unique ID that is used to reference the condition from a custom expression. Can only contain capital-case letters. The ID must be defined by the user when modifying filter conditions, but will be generated anew when requesting them afterward.
operator	integer	Condition operator. Valores possíveis: 0 - (default) =; 1 - <>; 2 - like; 3 - not like; 4 - in; 5 - >=; 6 - <=; 7 - not it.

To better understand how to use filters with various types of expressions, see examples on the action.get and action.create method pages.

The following operators and values are supported for each condition type.

Condition	Condition name	Supported operators	Expected value
0	Host group	=, <>	Host group ID.
1	Host	=, <>	Host ID.
2	Trigger	=, <>	Trigger ID.
3	Trigger name	like, not like	Trigger name.
4	Trigger severity	=, <>, >=, <=	Trigger severity. Refer to the trigger "severity" property for a list of supported trigger severities.
5	Trigger value	=	Trigger value. Refer to the trigger "value" property for a list of supported trigger values.
6	Time period	in, not in	Time when the event was triggered as a time period.
7	Host IP	=, <>	One or several IP ranges to check separated by commas. Refer to the network discovery configuration section for more information on supported formats of IP ranges.
8	Discovered service type	=, <>	Tipo do serviço descoberto. The type of service matches the type of the discovery check used to detect the service. Refer to the discovery check "type" property for a list of supported types.
9	Discovered service port	=, <>	Um ou vários intervalos de portas separados por vírgulas.
10	Discovery status	=	Status of a discovered object. Valores possíveis: 0 - host ou serviço up; 1 - host ou serviço fora; 2 - host ou serviço descobero; 3 - host ou serviço perdido.
11	Uptime or downtime duration	>=, <=	Indica há quanto tempo o objeto descoberto está no status atual, em segundos.
12	Received values	=, <>, >=, <=, like, not like	Valor retornado quando realizando verificações de descoberta dos tipos agente Zabbix, SNMPv1, SNMPv2 ou SNMPv3.
13	Host template	=, <>	ID do template associado.
15	Application	=, like, not like	Nome da aplicação.
16	Maintenance status	in, not in	Nenhum valor requerido; usar usar o operador "in" significa que o host deve estar em manutenção, "not in" - não em manutenção.
18	Discovery rule	=, <>	ID da regra de descoberta.
19	Discovery check	=, <>	ID da verificação de descoberta.
20	Proxy	=, <>	ID do proxy.
21	Discovery object	=	Tipo de objeto que disparou o gatilho para o evento de descoberta. Valores possíveis: 1 - host descoberto; 2 - serviço descoberto.
22	Host name	like, not like	Nome do host.
23	Event type	=	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	Host metadata	like, not like	Metadados do host auto-registrado.

Documentation