Os objetos a seguir estão diretamente relacionados à API discoveryrule
.
O objeto de regra de descoberta de baixo nível tem as seguintes propriedades..
Propriedade | Tipo | Descrição |
---|---|---|
itemid | string | (readonly) ID of the LLD rule. |
delay (requerido) |
string | Update interval of the LLD rule. AAceita segundos ou unidade de tempo com sufixo e com ou sem um ou mais intervalos personalizados que consistem em intervalos flexíveis e intervalos de agendamento como strings serializadas. Também aceita macros de usuário. Intervalos flexíveis podem ser escritos como duas macros separadas por uma barra. Os intervalos são separados por um ponto e vírgula. Opcional para o Zabbix trapper, itens dependentes e para o Zabbix agent(ativo) com a chave mqtt.get . |
hostid (requerido) |
string | ID do host ao qual a regra LLD pertence. |
interfaceid (requerido) |
string | ID da interface do host da regra LLD. Usado apenas para regras LLD do host. Não é necessário para o agente Zabbix (ativo), Zabbix internal, Zabbix trapper, dependente, dependente, monitor de banco de dados e script de regras LLD. Opcional para regras LLD do agente HTTP. |
key_ (requerido) |
string | Key da regra LLD. |
name (requerido) |
string | Nome da regra LLD. |
type (requerido) |
integer | Tipo de regra LLD. Valores possíveis: 0 - Zabbix agent; 2 - Zabbix trapper; 3 - simple check; 5 - Zabbix internal; 7 - Zabbix agent (ativo); 10 - external check; 11 - database monitor; 12 - IPMI agent; 13 - SSH agent; 14 - TELNET agent; 16 - JMX agent; 18 - Dependent item; 19 - HTTP agent; 20 - SNMP agent; 21 - Script. |
url (requerido) |
string | String de URL, necessária para a regra LLD do agente HTTP. Suporta macros de usuário, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. |
allow_traps | integer | Campo de regra LLD do agente HTTP. Permitir preencher o valor como no tipo de item do trapper também. 0 - (default) Não permite aceitar dados recebidos. 1 - Permite aceitar dados recebidos. |
authtype | integer | Usado apenas pelo SSH agent ou regras LLD do agente HTTP. Valores possíveis do método de autenticação do SSH agent: 0 - (default) senha; 1 - chave pública. HTTP Valores possíveis do método de autenticação do agente HTTP: 0 - (default) Nenhum 1 - básico 2 - NTLM |
description | string | Descrição da regra LLD. |
error | string | (somente leitura) Mensagem de erro se houver problemas ao atualizar a regra LLD. |
follow_redirects | integer | Campo de regra LLD do agente HTTP. Siga os redirecionamentos de resposta ao agrupar dados. 0 - Não siga redirecionamentos. 1 - (default) Seguir redirecionamentos. |
headers | object | Campo de regra LLD do agente HTTP. Objeto com cabeçalhos de solicitação HTTP(S), em que o nome do cabeçalho é usado como chave e o valor do cabeçalho como valor. Exemplo: { "User-Agent": "Zabbix" } |
http_proxy | string | Campo de regra LLD do agente HTTP. Cadeia de conexão do proxy HTTP(S). |
ipmi_sensor | string | Sensor IPMI. Usado apenas pelas regras do IPMI LLD. |
jmx_endpoint | string | Cadeia de conexão personalizada do agente JMX. Valor padrão: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
lifetime | string | Período de tempo após o qual os itens que não são mais descobertos serão excluídos. Aceita segundos, unidade de tempo com sufixo e macro do usuário. Padrão: 30d . |
master_itemid | integer | ID do item mestre. Recursão de até 3 itens dependentes e contagem máxima de itens dependentes igual a 999 são permitidas. A regra de descoberta não pode ser um item mestre para outra regra de descoberta. Obrigatório para item dependente. |
output_format | integer | Campo de regra LLD do agente HTTP. A resposta deve ser convertida em JSON. 0 - (padrão) Armazenamento não tratado. 1 - Converter para JSON. |
params | string | Parâmetros adicionais dependendo do tipo da regra LLD: - script executado para regras SSH e Telnet LLD; - Consulta SQL para regras LLD do monitor de banco de dados; - fórmula para regras LLD calculadas. |
parameters | array | Parâmetros adicionais para a regra LLD do tipo script. Matriz de objetos com propriedades 'name' e 'value', onde o nome deve ser único. |
password | string | Senha para autenticação. Usado por verificação simples, SSH, Telnet, monitor de banco de dados, JMX e regras LLD do agente HTTP. |
post_type | integer | Campo de regra LLD do agente HTTP. Tipo de corpo de dados de postagem armazenado na propriedade de postagen 0 - (padrão) Dados não tratados. 2 - Dados JSON. 3 - Dados XML. |
posts | string | Campo de regra LLD do agente HTTP. Dados do corpo da solicitação HTTP(S). Usado com post_type. |
privatekey | string | Nome do arquivo de chave privada. |
publickey | string | Nome do arquivo de chave pública. |
query_fields | array | Campo de regra LLD do agente HTTP. Parâmetros de consulta. Matriz de objetos com pares 'key':'value' onde valor pode ser uma string vazia. |
request_method | integer | Campo de regra LLD do agente HTTP. Tipo de método de solicitação. 0 - (padrão) GET 1 - POST 2 - PUT 3 - HEAD |
retrieve_mode | integer | Campo de regra LLD do agente HTTP. Que parte da resposta deve ser armazenada. 0 - (padrão) Body. 1 - Headers. 2 - O corpo e os cabeçalhos serão armazenados. Para request_method HEAD apenas 1 é o valor permitido. |
snmp_oid | string | SNMP OID. |
ssl_cert_file | string | Campo de regra LLD do agente HTTP. Caminho do arquivo de chave SSL pública. |
ssl_key_file | string | Campo de regra LLD do agente HTTP. Caminho do arquivo de chave SSL privada. |
ssl_key_password | string | Campo de regra LLD do agente HTTP. Senha para arquivo de chave SSL. |
state | integer | (somente leitura) Estado da regra LLD. Valores possíveis: 0 - (padrão) normal; 1 - não suportado. |
status | integer | Status da regra LLD. Valores possíveis: 0 - (padrão) regra LLD habilitada; 1 - regra LLD desabilitada. |
status_codes | string | Campo de regra LLD do agente HTTP. Intervalos de códigos de status HTTP necessários separados por vírgulas. Também suporta macros de usuário como parte da lista separada por vírgulas. Exemplo: 200,200-{$M},{$M},200-400 |
templateid | string | (somente leitura) ID da regra LLD do modelo pai. |
timeout | string | Tempo limite da solicitação de sondagem de dados do item. Usado para regras de agente HTTP e script LLD. Suporta macros de usuário. padrão: 3s valor máximo: 60s |
trapper_hosts | string | Hosts permitidos. Usado por regras LLD do trapper ou regras LLD do agente HTTP. |
username | string | Username for authentication. Used by simple check, SSH, Telnet, database monitor, JMX and HTTP agent LLD rulesNome de usuário para autenticação. Usado por verificação simples, SSH, Telnet, monitor de banco de dados, JMX e regras LLD do agente HTTP. Requerido pelas regras SSH e Telnet LLD. |
uuid | string | Identificador único universal, usado para vincular regras LLD importadas a regras já existentes. Usado apenas para regras LLD em modelos. Gerado automaticamente, se não fornecido. Para operações de atualização este campo é somente leitura. |
verify_host | integer | Campo de regra LLD do agente HTTP. Validar o nome do host na URL está no campo Common Name ou no campo Subject Alternate Name do certificado do host. 0 - (padrão) Não validado. 1 - Validado. |
verify_peer | integer | Campo de regra LLD do agente HTTP. Validar é o certificado do host autêntico. 0 - (padrão) Não validado. 1 - Validado. |
O objeto de filtro de regras LLD define um conjunto de condições que podem ser usadas
para filtrar objetos descobertos. Tem as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
conditions (requerido) |
array | Conjunto de condições de filtro a serem usadas para filtrar resultados. |
evaltype (requerido) |
integer | Método de avaliação da condição do filtro. Valores possíveis: 0 - and/or; 1 - and; 2 - or; 3 - expressão personalizada. |
eval_formula | string | (somente leitura) 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. |
formula | string | Expressão definida pelo usuário a ser usada para avaliar condições de filtros com uma expressão personalizada. 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 não utilizada ou omitida.Obrigatório para filtros de expressão personalizados. |
O objeto de condição de filtro de regra LLD define uma verificação separada a ser executada no valor de uma macro LLD. Possui as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
macro (requerido) |
string | Macro LLD para realizar a verificação. |
value (requerido) |
string | Valor para comparar. |
formulaid | string | ID exclusivo arbitrário que é usado para fazer referência à condição 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á-los posteriormente. |
operator | integer | Operador de condição. Valores possíveis: 8 - (padrão) corresponde à expressão regular; 9 - não corresponde à expressão regular; 12 - existe; 13 - não existe. |
Para entender melhor como usar filtros com vários tipos de expressões, veja exemplos nas páginas de método discoveryrule.get e discoveryrule.create.
O caminho da macro LLD tem as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
lld_macro (requerido) |
string | Macro LLD. |
path (requerido) |
string | Seletor para valor que será atribuído à macro correspondente. |
O objeto de pré-processamento de regra LLD tem as seguintes propriedades.
Propriedade | Tipo | Descrição |
---|---|---|
type (requerido) |
integer | O tipo de opção de pré-processamento. Valores possíveis: 5 - Correspondência de expressão regular; 11 - XML XPath; 12 - JSONPath; 15 - Não corresponde a expressão regular; 16 - Verificar erro no JSON; 17 - Verificar erro no XML; 20 - Descartar inalterado com pulsação; 23 - Prometheus para JSON; 24 - CSV para JSON; 25 - Substituir; 27 - XML para JSON. |
params (requerido) |
string | Additional Parâmetros adicionais usados pela opção de pré-processamento. Vários parâmetros são separados pelo caractere LF (\n). |
error_handler (requerido) |
integer | Tipo de ação usado em caso de falha na etapa de pré-processamento. Valores possíveis: 0 - Mensagem de erro é definida pelo Zabbix server; 1 - Descartar valor; 2 - Definir valor personalizado;< br>3 - Definir mensagem de erro personalizada. |
error_handler_params (requerido) |
string | Parâmetros do manipulador de erros. Usado com error_handler .Deve estar vazio, se error_handler for 0 ou 1.Pode estar vazio se, error_handler for 2.Não pode estar vazio, se error_handler é 3. |
Os seguintes parâmetros e manipuladores de erros são suportados para cada tipo de pré-processamento.
Tipo de pré-processamento | Nome | Parâmetro 1 | Parâmetro 2 | Parâmetro 3 | Manipuladores de erros compatíveis |
---|---|---|---|---|---|
5 | Expressão regular | pattern1 | output2 | 0, 1, 2, 3 | |
11 | XML XPath | path3 | 0, 1, 2, 3 | ||
12 | JSONPath | path3 | 0, 1, 2, 3 | ||
15 | Não corresponde à expressão regular | pattern1 | 0, 1, 2, 3 | ||
16 | Verifique se há erro no JSON | path3 | 0, 1, 2, 3 | ||
17 | Verifique se há erro no XML | path3 | 0, 1, 2, 3 | ||
20 | Descarte inalterado com heartbeat | seconds4, 5, 6 | |||
23 | Prometheus para JSON | pattern5, 7 | 0, 1, 2, 3 | ||
24 | CSV para JSON | character2 | character2 | 0,1 | 0, 1, 2, 3 |
25 | Substituir | search string2 | replacement2 | ||
27 | XML para JSON | 0, 1, 2, 3 |
1 expressão regular
2 string
3 JSONPath ou XML XPath
4 inteiro positivo (com suporte de sufixos de tempo, ex. 30s, 1m, 2h, 1d)
5 macro de usuário
6 macro LLD
7 padrão do Prometheus seguindo a sintaxe: <metric name>{<label name>="<label value>", ...} == <value>
. Cada componente padrão do Prometheus (métrica, nome do rótulo, valor do rótulo e valor da métrica) pode ser macro do usuário.
8 Saída do Prometheus seguindo a sintaxe: <label name>
.
O objeto de substituição de regra LLD define um conjunto de regras (filtros, condições e operações) que são usadas para substituir propriedades de diferentes objetos de protótipo. Possui as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
name (requerido) |
string | Nome de substituição exclusivo. |
step (requerido) |
integer | Número de pedido exclusivo da substituição. |
stop | integer | Parar de processar as próximas substituições se corresponder. Valores possíveis: 0 - (padrão) não pare de processar substituições; 1 - pare de processar substituições se o filtro corresponder. |
filter | object | Substituir filtro. |
operations | array | Substituir operações. |
O objeto de filtro de substituição de regra LLD define um conjunto de condições que, se corresponderem ao objeto descoberto, a substituição será aplicada. Possui as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
evaltype (requerido) |
integer | Substituir o método de avaliação da condição do filtro. Valores possíveis: 0 - e/ou; 1 - e; 2 - ou; 3 - expressão personalizada. |
conditions (requerido) |
array | Conjunto de condições de filtro de substituição a serem usadas para corresponder aos objetos descobertos. |
eval_formula | string | (somente leitura) Expressão gerada que será usada para avaliar as condições do filtro de substituição. A expressão contém códigos que fazem referência a condições de filtro de substituição 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 de substituição com uma expressão personalizada. A expressão deve conter IDs que façam referência a condições de filtro de substituição específicas por seu formulaid . Os IDs usados na expressão devem corresponder exatamente aos definidos nas condições do filtro de substituição: nenhuma condição pode permanecer sem uso ou omitida.Obrigatório para filtros de substituição de expressão personalizados. |
O objeto de condição de filtro de substituição de regra LLD define uma verificação separada a ser executada no valor de uma macro LLD. Possui as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
macro (requerido) |
string | Macro LLD para realizar a verificação. |
value (requerido) |
string | Valor para comparar. |
formulaid | string | ID exclusivo arbitrário que é usado para fazer referência à condição 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á-los posteriormente. |
operator | integer | Operador de condição. Valores possíveis: 8 - (padrão) corresponde à expressão regular; 9 - não corresponde à expressão regular; 12 - existe; 13 - corresponde não existe. |
A operação de substituição da regra LLD é uma combinação de condições e ações a serem executadas no objeto protótipo. Possui as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
operationobject (requerido) |
integer | Tipo de objeto descoberto para realizar a ação. Valores possíveis: 0 - Protótipo do item; 1 - Protótipo do trigger; 2 - Protótipo do gráfico; 3 - Protótipo do host. |
operator | integer | Operador de condição de substituição. Valores possíveis: 0 - (padrão) é igual; 1 - não é igual; 2 - contém; 3 - não contém; 8 - corresponde; 9 - não corresponde. |
value | string | Padrão para corresponder ao nome do item, trigger, gráfico ou protótipo do host, dependendo do objeto selecionado. |
opstatus | object | Substituir objeto de status de operação para objetos de protótipo de item, trigger e host. |
opdiscover | object | Operação de substituição descobrir objeto de status (todos os tipos de objeto). |
opperiod | object | Substituir objeto de período de operação (intervalo de atualização) para objeto de protótipo de item. |
ohistory | object | Substituir objeto de histórico de operação para objeto de protótipo de item. |
optrends | object | Substituir objeto de tendências de operação para objeto protótipo de item. |
opseverity | object | Substituir objeto de gravidade de operação para objeto protótipo de trigger. |
optag | array | Substituir objeto de etiqueta de operação para objetos de protótipo de trigger e host. |
optemplate | array | Substituir objeto de modelo de operação para objeto de protótipo de host. |
opinventory | object | Substituir objeto de inventário de operação para objeto de protótipo do host. |
A regra LLD substitui o status de operação definido como objeto descoberto. Tem as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
status (requerido) |
integer | Substituir o status do objeto selecionado. Valores possíveis: 0 - Criar ativado; 1 - Criar desativado. |
O status de descoberta da operação de substituição da regra LLD é definido como objeto descoberto. Tem as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
discover (requerido) |
integer | Substituir o status de descoberta do objeto selecionado. Valores possíveis: 0 - Sim, continue descobrindo os objetos; 1 - Não, novos objetos não serão descobertos e os existentes serão marcados como perdidos. |
O período de operação de substituição de regra LLD é um valor de intervalo de atualização (suporta intervalos personalizados) que está definido como item descoberto. Tem o seguinte propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
delay (obrigatório) |
string | Substituir o intervalo de atualização do protótipo de item. Aceita segundos ou uma unidade de tempo com sufixo (30s,1m,2h,1d) bem como intervalos flexíveis e agendados e macros de usuário ou macros LLD. Vários intervalos são separados por um ponto e vírgula. |
Valor do histórico da operação de substituição da regra LLD que está definido como item descoberto. Tem as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
histórico (required) |
string | Substitua o histórico do protótipo do item, que é uma unidade de tempo de quanto tempo os dados do histórico devem ser armazenados. Também aceita macro de usuário e macro LLD. |
Valor de tendências de operação de substituição de regra LLD que é definido como item descoberto. Tem as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
Tendências (obrigatório) |
string | Substitua as tendências do protótipo do item, que é uma unidade de tempo de quanto tempo os dados de tendências devem ser armazenados. Também aceita macro de usuário e macro LLD. |
O valor de gravidade da operação de substituição da regra LLD que está definido para o gatilho descoberto. Tem as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
Severidade (obrigatório) |
inteiro | Substituir a gravidade do protótipo do acionador. Os valores possíveis são: 0 - (padrão) não classificado; 1 - informação; 2 - atenção; 3 - média; 4 - alta; 5 - desastre. |
O objeto de etiqueta de operação de substituição de regra LLD contém o nome e o valor da etiqueta que são definidos como objeto descoberto. Tem as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
etiqueta (obrigatório) |
string | Novo nome da etiqueta. |
valor | string | Novo valor da etiqueta. |
Objeto de modelo de operação de substituição de regra LLD que está vinculado ao host descoberto. Tem as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
Template ID (obrigatório) |
string | Substitua o modelo de modelos vinculados de protótipo de host. |
A regra LLD substitui o valor do modo de inventário da operação definido como host descoberto. Possui as seguintes propriedades:
Propriedade | Tipo | Descrição |
---|---|---|
inventory_mode (required) |
integer | Substitua o modo de inventário do protótipo do host. Os valores possíveis são: -1 - desativado; 0 - (padrão) manual; 1 - automático. |