Nesta página
Objeto de protótipo de item
Os seguintes objetos estão diretamente relacionados à API itemprototype.
Protótipo de item
O objeto de protótipo de item tem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| itemid | ID | ID do protótipo de item. Comportamento da propriedade: - somente leitura - obrigatório para operações de atualização |
| delay | string | Intervalo de atualização do protótipo de item. Aceita um número de segundos (por exemplo, 1, 60, 300), um valor com um sufixo de tempo (por exemplo, 30s, 1m, 2h, 1d) ou, opcionalmente, um ou mais intervalos personalizados, todos separados por ponto e vírgula. Os intervalos personalizados podem ser uma combinação de intervalos flexíveis e de agendamento.Aceita macros de usuário e macros LLD. Quando usado, o valor deve ser uma única macro. Não há suporte para várias macros ou macros combinadas com texto. Os intervalos flexíveis podem ser escritos como duas macros separadas por uma barra (por exemplo, {$FLEX_INTERVAL}/{$FLEX_PERIOD}).Exemplo: 1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}Comportamento da propriedade: - obrigatório se type estiver definido como "Zabbix agent" (0), "Simple check" (3), "Zabbix internal" (5), "External check" (10), "Database monitor" (11), "IPMI agent" (12), "SSH agent" (13), "TELNET agent" (14), "Calculated" (15), "JMX agent" (16), "HTTP agent" (19), "SNMP agent" (20), "Script" (21), "Browser" (22), ou se type estiver definido como "Zabbix agent (active)" (7) e key_ não contiver "mqtt.get" |
| hostid | ID | ID do host ao qual o protótipo de item pertence. Comportamento da propriedade: - constante - obrigatório para operações de criação |
| interfaceid | ID | ID da interface de host do protótipo de item. Comportamento da propriedade: - obrigatório se o protótipo de item pertencer a um host e type estiver definido como "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap" ou "SNMP agent"- com suporte se o protótipo de item pertencer a um host e type estiver definido como "Simple check", "External check", "SSH agent", "TELNET agent" ou "HTTP agent" |
| key_ | string | Chave do protótipo de item. Comportamento da propriedade: - obrigatório para operações de criação - somente leitura para objetos herdados |
| name | string | Nome do protótipo de item. Oferece suporte a macros de usuário. Comportamento da propriedade: - obrigatório para operações de criação - somente leitura para objetos herdados |
| type | integer | Tipo do protótipo de item. Valores possíveis: 0 - Zabbix agent; 2 - Zabbix trapper; 3 - Simple check; 5 - Zabbix internal; 7 - Zabbix agent (active); 10 - External check; 11 - Database monitor; 12 - IPMI agent; 13 - SSH agent; 14 - TELNET agent; 15 - Calculated; 16 - JMX agent; 17 - SNMP trap; 18 - Dependent item; 19 - HTTP agent; 20 - SNMP agent; 21 - Script; 22 - Browser. Comportamento da propriedade: - obrigatório para operações de criação - somente leitura para objetos herdados |
| url | string | String de URL. Oferece suporte a macros LLD, macros de usuário, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. Comportamento da propriedade: - obrigatório se type estiver definido como "HTTP agent"- somente leitura para objetos herdados |
| value_type | integer | Tipo de informação do protótipo de item. Valores possíveis: 0 - ponto flutuante numérico; 1 - caractere; 2 - log; 3 - inteiro sem sinal numérico; 4 - texto; 5 - binário. Comportamento da propriedade: - obrigatório para operações de criação - somente leitura para objetos herdados |
| allow_traps | integer | Permite preencher o valor de forma semelhante ao item trapper. 0 - (padrão) Não permite aceitar dados recebidos; 1 - Permite aceitar dados recebidos. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent" |
| authtype | integer | Método de autenticação. Valores possíveis se type estiver definido como "SSH agent":0 - (padrão) senha; 1 - chave pública. Valores possíveis se type estiver definido como "HTTP agent":0 - (padrão) nenhum; 1 - básico; 2 - NTLM; 3 - Kerberos; 4 - Digest. Comportamento da propriedade: - com suporte se type estiver definido como "SSH agent" ou "HTTP agent"- somente leitura para objetos herdados (se type estiver definido como "HTTP agent") |
| description | string | Descrição do protótipo de item. |
| follow_redirects | integer | Seguir redirecionamentos da resposta durante a coleta de dados. Valores possíveis: 0 - Não seguir redirecionamentos; 1 - (padrão) Seguir redirecionamentos. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados |
| headers | array | Matriz de cabeçalhos que será enviada ao executar uma solicitação HTTP. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados |
| history | string | Unidade de tempo durante a qual os dados do histórico devem ser armazenados. Também aceita macro de usuário e macro LLD. Padrão: 31d. |
| http_proxy | string | String de conexão do proxy HTTP(S). Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados |
| ipmi_sensor | string | Sensor IPMI. Comportamento da propriedade: - obrigatório se type estiver definido como "IPMI agent" e key_ não estiver definido como "ipmi.get"- com suporte se type estiver definido como "IPMI agent"- somente leitura para objetos herdados |
| jmx_endpoint | string | String de conexão personalizada do JMX agent. Padrão: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi Comportamento da propriedade: - com suporte se type estiver definido como "JMX agent" |
| logtimefmt | string | Formato da hora nas entradas de log. Comportamento da propriedade: - com suporte se value_type estiver definido como "log"- somente leitura para objetos herdados |
| master_itemid | ID | ID do item mestre. É permitida recursão de até 3 itens dependentes e protótipos de item, com uma quantidade máxima de itens dependentes e protótipos de item igual a 29999. Comportamento da propriedade: - obrigatório se type estiver definido como "Dependent item"- somente leitura para objetos herdados |
| output_format | integer | Define se a resposta deve ser convertida para JSON. Valores possíveis: 0 - (padrão) Armazenar dados brutos; 1 - Converter para JSON. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados |
| params | string | Parâmetros adicionais dependendo do tipo do protótipo de item: - script executado para protótipos de item SSH agent e TELNET agent; - consulta SQL para protótipos de item Database monitor; - fórmula para protótipos de item Calculated; - script para protótipos de item Script e Browser. Comportamento da propriedade: - obrigatório se type estiver definido como "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script" ou "Browser"- somente leitura para objetos herdados (se type estiver definido como "Script" ou "Browser") |
| parameters | object/array | Parâmetros adicionais se type estiver definido como "Script" ou "Browser". Matriz de objetos com as propriedades name e value, em que name deve ser exclusivo.Comportamento da propriedade: - com suporte se type estiver definido como "Script" ou "Browser"- somente leitura para objetos herdados |
| password | string | Senha para autenticação. Comportamento da propriedade: - obrigatório se type estiver definido como "JMX agent" e username estiver definido- com suporte se type estiver definido como "Simple check", "SSH agent", "TELNET agent", "Database monitor" ou "HTTP agent"- somente leitura para objetos herdados (se type estiver definido como "HTTP agent") |
| post_type | integer | Tipo do corpo de dados de postagem armazenado na propriedade posts.Valores possíveis: 0 - (padrão) Dados brutos. 2 - Dados JSON. 3 - Dados XML. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados |
| posts | string | Dados do corpo da solicitação HTTP(S). Comportamento da propriedade: - obrigatório se type estiver definido como "HTTP agent" e post_type estiver definido como "JSON data" ou "XML data"- com suporte se type estiver definido como "HTTP agent" e post_type estiver definido como "Raw data"- somente leitura para objetos herdados |
| privatekey | string | Nome do arquivo de chave privada. Comportamento da propriedade: - obrigatório se type estiver definido como "SSH agent" e authtype estiver definido como "public key" |
| publickey | string | Nome do arquivo de chave pública. Comportamento da propriedade: - obrigatório se type estiver definido como "SSH agent" e authtype estiver definido como "public key" |
| query_fields | array | Matriz de campos de consulta que será enviada ao executar uma solicitação HTTP. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados |
| request_method | integer | Tipo do método de solicitação. Valores possíveis: 0 - (padrão) GET; 1 - POST; 2 - PUT; 3 - HEAD. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados |
| retrieve_mode | integer | Parte da resposta que deve ser armazenada. Valores possíveis se request_method estiver definido como "GET", "POST" ou "PUT":0 - (padrão) Corpo; 1 - Cabeçalhos; 2 - O corpo e os cabeçalhos serão armazenados. Valores possíveis se request_method estiver definido como "HEAD":1 - Cabeçalhos. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados |
| snmp_oid | string | OID SNMP. Comportamento da propriedade: - obrigatório se type estiver definido como "SNMP agent"- somente leitura para objetos herdados |
| ssl_cert_file | string | Caminho do arquivo de chave SSL pública. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados |
| ssl_key_file | string | Caminho do arquivo de chave SSL privada. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados |
| ssl_key_password | string | Senha do arquivo de chave SSL. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados |
| status | integer | Status do protótipo de item. Valores possíveis: 0 - (padrão) protótipo de item habilitado; 1 - protótipo de item desabilitado; 3 - protótipo de item sem suporte. |
| status_codes | string | Intervalos de códigos de status HTTP necessários, separados por vírgulas. Também oferece suporte a macros de usuário ou macros LLD como parte da lista separada por vírgulas. Exemplo: 200,200-{$M},{$M},200-400 Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados |
| templateid | ID | ID do protótipo de item do template pai. Comportamento da propriedade: - somente leitura |
| timeout | string | Tempo limite da solicitação de coleta de dados do item. Aceita um número de segundos (por exemplo, 1, 60) ou um valor com um sufixo de tempo (por exemplo, 30s, 1m). Também aceita macros de usuário e macros LLD.O intervalo de valores possíveis é: 1-600s. Padrão: "" - usar as configurações do proxy/globais. Comportamento da propriedade: - com suporte se type estiver definido como "Zabbix agent" (0), "Simple check" (3) e key_ não começar com "vmware." e "icmpping", "Zabbix agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH agent" (13), "TELNET agent" (14), "HTTP agent" (19), "SNMP agent" (20) e snmp_oid começar com "walk[" ou "get[", "Script" (21), "Browser" (22)- somente leitura para objetos herdados |
| trapper_hosts | string | Hosts permitidos. Comportamento da propriedade: - com suporte se type estiver definido como "Zabbix trapper", ou se type estiver definido como "HTTP agent" e allow_traps estiver definido como "Allow to accept incoming data" |
| trends | string | Unidade de tempo durante a qual os dados de tendências devem ser armazenados. Também aceita macro de usuário e macro LLD. Padrão: 365d. Comportamento da propriedade: - com suporte se value_type estiver definido como "numeric float" ou "numeric unsigned" |
| units | string | Unidades do valor. Comportamento da propriedade: - com suporte se value_type estiver definido como "numeric float" ou "numeric unsigned"- somente leitura para objetos herdados |
| username | string | Nome de usuário para autenticação. Comportamento da propriedade: - obrigatório se type estiver definido como "SSH agent" ou "TELNET agent", ou se type estiver definido como "JMX agent" e password estiver definido- com suporte se type estiver definido como "Simple check", "Database monitor" ou "HTTP agent"- somente leitura para objetos herdados (se type estiver definido como "HTTP agent") |
| uuid | string | Identificador universal exclusivo, usado para vincular protótipos de item importados aos já existentes. Gerado automaticamente se não for fornecido. Comportamento da propriedade: - com suporte se o protótipo de item pertencer a um template |
| valuemapid | ID | ID do mapa de valores associado. Comportamento da propriedade: - com suporte se value_type estiver definido como "numeric float", "character" ou "numeric unsigned"- somente leitura para objetos herdados |
| verify_host | integer | Define se deve validar se o nome do host da conexão corresponde ao nome no certificado do host. Valores possíveis: 0 - (padrão) Não validar; 1 - Validar. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados |
| verify_peer | integer | Define se deve validar se o certificado do host é autêntico. Valores possíveis: 0 - (padrão) Não validar; 1 - Validar. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados |
| discover | integer | Status da descoberta do protótipo de item. Valores possíveis: 0 - (padrão) novos itens serão descobertos; 1 - novos itens não serão descobertos e os itens existentes serão marcados como perdidos. |
Cabeçalho HTTP
O objeto header possui as seguintes propriedades:
| Propriedade | Tipo | Descrição |
|---|---|---|
| name | string | Nome do cabeçalho HTTP. Comportamento da propriedade: - obrigatório |
| value | string | Valor do cabeçalho. Comportamento da propriedade: - obrigatório |
Campo de consulta HTTP
O objeto de campo de consulta define um nome e valor que é usado para especificar um parâmetro de URL. Ele possui as seguintes propriedades:
| Propriedade | Tipo | Descrição |
|---|---|---|
| name | string | Nome do parâmetro. Comportamento da propriedade: - obrigatório |
| value | string | Valor do parâmetro. Comportamento da propriedade: - obrigatório |
Tag de prototype de item
O objeto de tag de prototype de item possui as seguintes propriedades.
| Property | Type | Description |
|---|---|---|
| tag | string | Nome da tag do prototype de item. Property behavior: - required |
| value | string | Valor da tag do prototype de item. |
Pré-processamento do protótipo de item
O objeto de pré-processamento do protótipo de item tem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| type | integer | O tipo de opção de pré-processamento. Valores possíveis: 1 - Multiplicador personalizado; 2 - Remover espaços à direita; 3 - Remover espaços à esquerda; 4 - Remover espaços; 5 - Expressão regular; 6 - Booleano para decimal; 7 - Octal para decimal; 8 - Hexadecimal para decimal; 9 - Alteração simples; 10 - Alteração por segundo; 11 - XPath XML; 12 - JSONPath; 13 - No intervalo; 14 - Corresponde à expressão regular; 15 - Não corresponde à expressão regular; 16 - Verificar erro em JSON; 17 - Verificar erro em XML; 18 - Verificar erro usando expressão regular; 19 - Descartar inalterado; 20 - Descartar inalterado com heartbeat; 21 - JavaScript; 22 - Padrão do Prometheus; 23 - Prometheus para JSON; 24 - CSV para JSON; 25 - Substituir; 26 - Verificar não suportado; 27 - XML para JSON; 28 - Valor da caminhada SNMP; 29 - Caminhada SNMP para JSON; 30 - Valor obtido via SNMP. Comportamento da propriedade: - obrigatória |
| params | string | Parâmetros adicionais usados pela opção de pré-processamento. Vários parâmetros são separados pelo caractere de nova linha (\n). Se type estiver definido como "Verificar não suportado", os parâmetros seguem a sintaxe <scope>[\n<pattern>], em que pattern é uma expressão regular e scope é um dos seguintes:-1 - corresponder a qualquer erro; \ 0 - verificar se a mensagem de erro corresponde a pattern; \ 1 - verificar se a mensagem de erro não corresponde a pattern. Comportamento da propriedade: - obrigatória se type estiver definido como "Multiplicador personalizado" (1), "Remover espaços à direita" (2), "Remover espaços à esquerda" (3), "Remover espaços" (4), "Expressão regular" (5), "XPath XML" (11), "JSONPath" (12), "No intervalo" (13), "Corresponde à expressão regular" (14), "Não corresponde à expressão regular" (15), "Verificar erro em JSON" (16), "Verificar erro em XML" (17), "Verificar erro usando expressão regular" (18), "Descartar inalterado com heartbeat" (20), "JavaScript" (21), "Padrão do Prometheus" (22), "Prometheus para JSON" (23), "CSV para JSON" (24), "Substituir" (25), "Verificar não suportado" (26), "Valor da caminhada SNMP" (28), "Caminhada SNMP para JSON" (29) ou "Valor obtido via SNMP" (30) |
| error_handler | integer | Tipo de ação usado em caso de falha da etapa de pré-processamento. Valores possíveis: 0 - A mensagem de erro é definida pelo Zabbix server; 1 - Descartar valor; 2 - Definir valor personalizado; 3 - Definir mensagem de erro personalizada. Valores possíveis se type estiver definido como "Verificar não suportado":1 - Descartar valor; 2 - Definir valor personalizado; 3 - Definir mensagem de erro personalizada. Comportamento da propriedade: - obrigatória se type estiver definido como "Multiplicador personalizado" (1), "Expressão regular" (5), "Booleano para decimal" (6), "Octal para decimal" (7), "Hexadecimal para decimal" (8), "Alteração simples" (9), "Alteração por segundo" (10), "XPath XML" (11), "JSONPath" (12), "No intervalo" (13), "Corresponde à expressão regular" (14), "Não corresponde à expressão regular" (15), "Verificar erro em JSON" (16), "Verificar erro em XML" (17), "Verificar erro usando expressão regular" (18), "Padrão do Prometheus" (22), "Prometheus para JSON" (23), "CSV para JSON" (24), "Verificar não suportado" (26), "XML para JSON" (27), "Valor da caminhada SNMP" (28), "Caminhada SNMP para JSON" (29) ou "Valor obtido via SNMP" (30) |
| error_handler_params | string | Parâmetros do manipulador de erros. Comportamento da propriedade: - obrigatória se error_handler estiver definido como "Definir valor personalizado" ou "Definir mensagem de erro personalizada" |
Os parâmetros e manipuladores de erros a seguir são compatíveis com cada tipo de pré-processamento.
| Tipo de pré-processamento | Nome | Parâmetro 1 | Parâmetro 2 | Parâmetro 3 | Manipuladores de erros compatíveis |
|---|---|---|---|---|---|
| 1 | Multiplicador personalizado | número1, 6 | 0, 1, 2, 3 | ||
| 2 | Remover espaços à direita | lista de caracteres2 | |||
| 3 | Remover espaços à esquerda | lista de caracteres2 | |||
| 4 | Remover espaços | lista de caracteres2 | |||
| 5 | Expressão regular | padrão3 | saída2 | 0, 1, 2, 3 | |
| 6 | Booleano para decimal | 0, 1, 2, 3 | |||
| 7 | Octal para decimal | 0, 1, 2, 3 | |||
| 8 | Hexadecimal para decimal | 0, 1, 2, 3 | |||
| 9 | Alteração simples | 0, 1, 2, 3 | |||
| 10 | Alteração por segundo | 0, 1, 2, 3 | |||
| 11 | XPath XML | caminho4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | caminho4 | 0, 1, 2, 3 | ||
| 13 | No intervalo | mín.1, 6 | máx.1, 6 | 0, 1, 2, 3 | |
| 14 | Corresponde à expressão regular | padrão3 | 0, 1, 2, 3 | ||
| 15 | Não corresponde à expressão regular | padrão3 | 0, 1, 2, 3 | ||
| 16 | Verificar erro em JSON | caminho4 | 0, 1, 2, 3 | ||
| 17 | Verificar erro em XML | caminho4 | 0, 1, 2, 3 | ||
| 18 | Verificar erro usando expressão regular | padrão3 | saída2 | 0, 1, 2, 3 | |
| 19 | Descartar inalterado | ||||
| 20 | Descartar inalterado com heartbeat | segundos5, 6 | |||
| 21 | JavaScript | script2 | |||
| 22 | Padrão do Prometheus | padrão6, 7 | value, label, function |
saída8, 9 | 0, 1, 2, 3 |
| 23 | Prometheus para JSON | padrão6, 7 | 0, 1, 2, 3 | ||
| 24 | CSV para JSON | caractere2 | caractere2 | 0,1 | 0, 1, 2, 3 |
| 25 | Substituir | string de pesquisa2 | substituição2 | ||
| 26 | Verificar não suportado | escopo1 | padrão3, 6 | 1, 2, 3 | |
| 27 | XML para JSON | 0, 1, 2, 3 | |||
| 28 | Valor da caminhada SNMP | OID2 | Formato: 0 - Inalterado 1 - UTF-8 de Hex-STRING 2 - MAC de Hex-STRING 3 - Inteiro de BITS |
0, 1, 2, 3 | |
| 29 | Caminhada SNMP para JSON10 | Nome do campo2 | Prefixo do OID2 | Formato: 0 - Inalterado 1 - UTF-8 de Hex-STRING 2 - MAC de Hex-STRING 3 - Inteiro de BITS |
0, 1, 2, 3 |
| 30 | Valor obtido via SNMP | Formato: 1 - UTF-8 de Hex-STRING 2 - MAC de Hex-STRING 3 - Inteiro de BITS |
0, 1, 2, 3 | ||
1 número inteiro ou de ponto flutuante
2 string
3 expressão regular
4 JSONPath ou XPath XML
5 número inteiro positivo (com suporte a sufixos de tempo (por exemplo, 30s, 1m, 2h, 1d))
6 macro de usuário, macro de LLD
7 padrão do Prometheus seguindo a sintaxe:
<metric name>{<label name>="<label value>", ...} == <value>. Cada
componente do padrão do Prometheus (métrica, nome do rótulo, valor do rótulo e
valor da métrica) pode ser uma macro de usuário ou macro de LLD.
8 saída do Prometheus seguindo a sintaxe: <label name> (pode ser uma macro de usuário ou uma macro de LLD) se label estiver selecionado como o
segundo parâmetro.
9 Uma das funções de agregação: sum, min, max, avg, count se function estiver selecionado como o segundo
parâmetro.
10 Compatível com vários registros "Nome do campo,Prefixo do OID,Formato", delimitados por um caractere de nova linha.