Table of Contents
Objeto de protótipo de item
Os seguintes objetos estão diretamente relacionados à API itemprototype.
Protótipo de item
O objeto protótipo de item possui 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 segundos ou unidade de tempo com sufixo (por exemplo, 30s, 1m, 2h, 1d) e, opcionalmente, um ou mais intervalos personalizados, todos separados por ponto e vírgula. Intervalos personalizados podem ser uma mistura de intervalos flexíveis e de agendamento. Aceita macros de usuário e macros LLD. Se usado, o valor deve ser uma única macro. Múltiplas macros ou macros misturadas com texto não são suportadas. 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 for 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 for 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 do host do protótipo de item. Comportamento da propriedade: - obrigatório se o protótipo de item pertencer ao host e type for definido como "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap" ou "SNMP agent"- suportado se o protótipo de item pertencer ao host e type for 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. Suporta 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. Suporta macros LLD, macros de usuário, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}. Comportamento da propriedade: - obrigatório se type for 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 - numérico float; 1 - caractere; 2 - log; 3 - numérico sem sinal; 4 - texto; 5 - binário. Comportamento da propriedade: - obrigatório para operações de criação - somente leitura para objetos herdados |
| allow_traps | integer | Permitir popular valor de forma semelhante ao item trapper. 0 - (padrão) Não permitir aceitar dados recebidos; 1 - Permitir aceitar dados recebidos. Comportamento da propriedade: - suportado se type for definido como "HTTP agent" |
| authtype | integer | Método de autenticação. Valores possíveis se type for definido como "SSH agent":0 - (padrão) senha; 1 - chave pública. Valores possíveis se type for definido como "HTTP agent":0 - (padrão) nenhum; 1 - básico; 2 - NTLM; 3 - Kerberos. Comportamento da propriedade: - suportado se type for definido como "SSH agent" ou "HTTP agent"- somente leitura para objetos herdados (se type for definido como "HTTP agent") |
| description | string | Descrição do protótipo de item. |
| flags | integer | Origem do protótipo de item. Valores possíveis: 2 - um protótipo de item; 6 - um protótipo de item descoberto Comportamento da propriedade: - somente leitura |
| follow_redirects | integer | Seguir redirecionamentos de resposta ao coletar dados. Valores possíveis: 0 - Não seguir redirecionamentos; 1 - (padrão) Seguir redirecionamentos. Comportamento da propriedade: - suportado se type for definido como "HTTP agent"- somente leitura para objetos herdados |
| headers | array | Array de cabeçalhos que serão enviados ao realizar uma requisição HTTP. Comportamento da propriedade: - suportado se type for definido como "HTTP agent"- somente leitura para objetos herdados |
| history | string | Unidade de tempo de quanto tempo os dados de 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: - suportado se type for definido como "HTTP agent"- somente leitura para objetos herdados |
| ipmi_sensor | string | Sensor IPMI. Comportamento da propriedade: - obrigatório se type for definido como "IPMI agent" e key_ não for definido como "ipmi.get"- suportado se type for definido como "IPMI agent"- somente leitura para objetos herdados |
| jmx_endpoint | string | String de conexão personalizada do Java gateway. Padrão: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi Comportamento da propriedade: - suportado se type for definido como "JMX agent" |
| logtimefmt | string | Formato da hora nas entradas de log. Comportamento da propriedade: - suportado se value_type for definido como "log"- somente leitura para objetos herdados |
| master_itemid | ID | ID do item mestre. Comportamento da propriedade: - obrigatório se type for definido como "Dependent item"- somente leitura para objetos herdados |
| output_format | integer | Se a resposta deve ser convertida para JSON. Valores possíveis: 0 - (padrão) Armazenar bruto; 1 - Converter para JSON. Comportamento da propriedade: - suportado se type for 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; - o script para protótipos de item script e browser. Comportamento da propriedade: - obrigatório se type for definido como "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script" ou "Browser"- somente leitura para objetos herdados (se type for definido como "Script" ou "Browser") |
| parameters | object/array | Parâmetros adicionais se type for definido como "Script" ou "Browser". Array de objetos com propriedades name e value, onde name deve ser único.Comportamento da propriedade: - suportado se type for definido como "Script" ou "Browser"- somente leitura para objetos herdados |
| password | string | Senha para autenticação. Comportamento da propriedade: - obrigatório se type for definido como "JMX agent" e username estiver definido- suportado se type for definido como "Simple check", "SSH agent", "TELNET agent", "Database monitor" ou "HTTP agent"- somente leitura para objetos herdados (se type for definido como "HTTP agent") |
| post_type | integer | Tipo de corpo de dados postados armazenados na propriedade posts.Valores possíveis: 0 - (padrão) Dados brutos. 2 - Dados JSON. 3 - Dados XML. Comportamento da propriedade: - suportado se type for definido como "HTTP agent"- somente leitura para objetos herdados |
| posts | string | Dados do corpo da requisição HTTP(S). Comportamento da propriedade: - obrigatório se type for definido como "HTTP agent" e post_type for definido como "JSON data" ou "XML data"- suportado se type for definido como "HTTP agent" e post_type for definido como "Raw data"- somente leitura para objetos herdados |
| privatekey | string | Nome do arquivo da chave privada. Comportamento da propriedade: - obrigatório se type for definido como "SSH agent" e authtype for definido como "public key" |
| publickey | string | Nome do arquivo da chave pública. Comportamento da propriedade: - obrigatório se type for definido como "SSH agent" e authtype for definido como "public key" |
| query_fields | array | Array de campos de consulta que serão enviados ao realizar uma requisição HTTP. Comportamento da propriedade: - suportado se type for definido como "HTTP agent"- somente leitura para objetos herdados |
| request_method | integer | Tipo de método de requisição. Valores possíveis: 0 - (padrão) GET; 1 - POST; 2 - PUT; 3 - HEAD. Comportamento da propriedade: - suportado se type for definido como "HTTP agent"- somente leitura para objetos herdados |
| retrieve_mode | integer | Qual parte da resposta deve ser armazenada. Valores possíveis se request_method for definido como "GET", "POST" ou "PUT":0 - (padrão) Corpo; 1 - Cabeçalhos; 2 - Corpo e cabeçalhos serão armazenados. Valores possíveis se request_method for definido como "HEAD":1 - Cabeçalhos. Comportamento da propriedade: - suportado se type for definido como "HTTP agent"- somente leitura para objetos herdados |
| snmp_oid | string | OID SNMP. Comportamento da propriedade: - obrigatório se type for definido como "SNMP agent"- somente leitura para objetos herdados |
| ssl_cert_file | string | Caminho do arquivo da chave pública SSL. Comportamento da propriedade: - suportado se type for definido como "HTTP agent"- somente leitura para objetos herdados |
| ssl_key_file | string | Caminho do arquivo da chave privada SSL. Comportamento da propriedade: - suportado se type for definido como "HTTP agent"- somente leitura para objetos herdados |
| ssl_key_password | string | Senha para o arquivo de chave SSL. Comportamento da propriedade: - suportado se type for 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 não suportado. |
| status_codes | string | Intervalos de códigos de status HTTP necessários, separados por vírgula. Também suporta macros de usuário ou macros LLD como parte da lista separada por vírgula. Exemplo: 200,200-{$M},{$M},200-400 Comportamento da propriedade: - suportado se type for definido como "HTTP agent"- somente leitura para objetos herdados |
| templateid | ID | ID do protótipo de item da template pai. Comportamento da propriedade: - somente leitura |
| timeout | string | Tempo limite da requisição de coleta de dados do item. Aceita segundos ou unidade de tempo com sufixo (por exemplo, 30s, 1m). Também aceita macros de usuário e macros LLD. Valores possíveis: 1-600s. Padrão: "" - usar configurações do proxy/globais. Comportamento da propriedade: - suportado se type for 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: - suportado se type for definido como "Zabbix trapper", ou se type for definido como "HTTP agent" e allow_traps for definido como "Allow to accept incoming data" |
| trends | string | Unidade de tempo de quanto tempo os dados de tendências devem ser armazenados. Também aceita macro de usuário e macro LLD. Padrão: 365d. Comportamento da propriedade: - suportado se value_type for definido como "numeric float" ou "numeric unsigned" |
| units | string | Unidades de valor. Comportamento da propriedade: - suportado se value_type for 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 for definido como "SSH agent" ou "TELNET agent", ou se type for definido como "JMX agent" e password estiver definido- suportado se type for definido como "Simple check", "Database monitor" ou "HTTP agent"- somente leitura para objetos herdados (se type for definido como "HTTP agent") |
| uuid | string | Identificador único universal, usado para vincular protótipos de item importados aos já existentes. Gerado automaticamente, se não fornecido. Comportamento da propriedade: - suportado se o protótipo de item pertencer a uma template |
| valuemapid | ID | ID do mapa de valores associado. Comportamento da propriedade: - suportado se value_type for definido como "numeric float", "character" ou "numeric unsigned"- somente leitura para objetos herdados |
| verify_host | integer | Se deve validar que o nome do host para a conexão corresponde ao do certificado do host. Valores possíveis: 0 - (padrão) Não validar; 1 - Validar. Comportamento da propriedade: - suportado se type for definido como "HTTP agent"- somente leitura para objetos herdados |
| verify_peer | integer | Se deve validar que o certificado do host é autêntico. Valores possíveis: 0 - (padrão) Não validar; 1 - Validar. Comportamento da propriedade: - suportado se type for definido como "HTTP agent"- somente leitura para objetos herdados |
| discover | integer | Status de 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 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 protótipo de item
O objeto de tag de protótipo de item possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| tag | string | Nome da tag do protótipo de item. Comportamento da propriedade: - obrigatório |
| value | string | Valor da tag do protótipo de item. |
Pré-processamento de protótipo de item
O objeto de pré-processamento de protótipo de item possui 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 à direita; 3 - Remover à esquerda; 4 - Remover; 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 - XML XPath; 12 - JSONPath; 13 - Dentro do 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 Prometheus; 23 - Prometheus para JSON; 24 - CSV para JSON; 25 - Substituir; 26 - Verificar não suportado; 27 - XML para JSON; 28 - Valor SNMP walk; 29 - SNMP walk para JSON; 30 - Valor SNMP get. Comportamento da propriedade: - obrigatório |
| params | string | Parâmetros adicionais usados pela opção de pré-processamento. Múltiplos 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>], onde pattern é uma expressão regular e scope é um dos:-1 - corresponder a qualquer erro; 0 - verificar se a mensagem de erro corresponde ao pattern; 1 - verificar se a mensagem de erro não corresponde ao pattern. Comportamento da propriedade: - obrigatório se type estiver definido como "Multiplicador personalizado" (1), "Remover à direita" (2), "Remover à esquerda" (3), "Remover" (4), "Expressão regular" (5), "XML XPath" (11), "JSONPath" (12), "Dentro do 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 Prometheus" (22), "Prometheus para JSON" (23), "CSV para JSON" (24), "Substituir" (25), "Verificar não suportado" (26), "Valor SNMP walk" (28), "SNMP walk para JSON" (29) ou "Valor SNMP get" (30) |
| error_handler | integer | Tipo de ação usada 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; 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ório 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), "XML XPath" (11), "JSONPath" (12), "Dentro do 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 Prometheus" (22), "Prometheus para JSON" (23), "CSV para JSON" (24), "Verificar não suportado" (26), "XML para JSON" (27), "Valor SNMP walk" (28), "SNMP walk para JSON" (29) ou "Valor SNMP get" (30) |
| error_handler_params | string | Parâmetros do manipulador de erro. Comportamento da propriedade: - obrigatório se error_handler estiver definido como "Definir valor personalizado" ou "Definir mensagem de erro personalizada" |
Os seguintes parâmetros e manipuladores de erro 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 erro suportados |
|---|---|---|---|---|---|
| 1 | Multiplicador personalizado | número1, 6 | 0, 1, 2, 3 | ||
| 2 | Remover à direita | lista de caracteres2 | |||
| 3 | Remover à esquerda | lista de caracteres2 | |||
| 4 | Remover | 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 | XML XPath | caminho4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | caminho4 | 0, 1, 2, 3 | ||
| 13 | Dentro do intervalo | min1, 6 | max1, 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 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 busca2 | substituição2 | ||
| 26 | Verificar não suportado | escopo1 | padrão3, 6 | 1, 2, 3 | |
| 27 | XML para JSON | 0, 1, 2, 3 | |||
| 28 | Valor SNMP walk | OID2 | Formato: 0 - Inalterado 1 - UTF-8 de Hex-STRING 2 - MAC de Hex-STRING 3 - Inteiro de BITS |
0, 1, 2, 3 | |
| 29 | SNMP walk para JSON10 | Nome do campo2 | Prefixo 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 SNMP get | 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 XML XPath
5 número inteiro positivo (com suporte a sufixos de tempo, por exemplo, 30s, 1m, 2h, 1d)
6 macro de usuário, macro LLD
7 padrão Prometheus seguindo a sintaxe: <nome da métrica>{<nome do label>="<valor do label>", ...} == <valor>. Cada componente do padrão Prometheus (métrica, nome do label, valor do label e valor da métrica) pode ser macro de usuário ou macro LLD.
8 saída Prometheus seguindo a sintaxe: <nome do label> (pode ser uma macro de usuário ou uma macro LLD) se label for selecionado como o segundo parâmetro.
9 Uma das funções de agregação: sum, min, max, avg, count se function for selecionado como o segundo parâmetro.
10 Suporta múltiplos registros "Nome do campo,Prefixo OID,Formato" delimitados por um caractere de nova linha.