Nesta página
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 tem as seguintes propriedades.
| Property | Type | Description |
|---|---|---|
| itemid | ID | ID do protótipo de item. Property behavior: - read-only - required 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. Várias 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}Property behavior: - required 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. Property behavior: - constant - required para operações de criação |
| interfaceid | ID | ID da interface do host do protótipo de item. Property behavior: - required 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"- supported 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. Property behavior: - required para operações de criação - read-only para objetos herdados |
| name | string | Nome do protótipo de item. Suporta macros de usuário. Property behavior: - required para operações de criação - read-only 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. Property behavior: - required para operações de criação - read-only 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}, {ITEM.ID}, {ITEM.KEY}. Property behavior: - required se type estiver definido como "HTTP agent"- read-only para objetos herdados |
| value_type | integer | Tipo de informação do protótipo de item. Valores possíveis: 0 - numeric float; 1 - character; 2 - log; 3 - numeric unsigned; 4 - text; 5 - binary. Property behavior: - required para operações de criação - read-only para objetos herdados |
| allow_traps | integer | Permite preencher o valor de forma semelhante ao item trapper. 0 - (default) Não permite aceitar dados recebidos; 1 - Permite aceitar dados recebidos. Property behavior: - supported 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 - (default) password; 1 - public key. Valores possíveis se type estiver definido como "HTTP agent":0 - (default) none; 1 - basic; 2 - NTLM; 3 - Kerberos; 4 - Digest. Property behavior: - supported se type estiver definido como "SSH agent" ou "HTTP agent"- read-only 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 - (default) Seguir redirecionamentos. Property behavior: - supported se type estiver definido como "HTTP agent"- read-only para objetos herdados |
| headers | array | Array de headers que serão enviados ao executar uma solicitação HTTP. Property behavior: - supported se type estiver definido como "HTTP agent"- read-only para objetos herdados |
| history | string | Uma unidade de tempo que define por quanto tempo os dados de histórico devem ser armazenados. Também aceita macro de usuário e macro LLD. Default: 31d. |
| http_proxy | string | String de conexão do proxy HTTP(S). Property behavior: - supported se type estiver definido como "HTTP agent"- read-only para objetos herdados |
| ipmi_sensor | string | Sensor IPMI. Property behavior: - required se type estiver definido como "IPMI agent" e key_ não estiver definido como "ipmi.get"- supported se type estiver definido como "IPMI agent"- read-only para objetos herdados |
| jmx_endpoint | string | String de conexão personalizada do JMX agent. Default: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi Property behavior: - supported se type estiver definido como "JMX agent" |
| logtimefmt | string | Formato da hora nas entradas de log. Property behavior: - supported se value_type estiver definido como "log"- read-only para objetos herdados |
| master_itemid | ID | ID do item mestre. É permitida recursão de até 3 itens dependentes e protótipos de item, e o número máximo de itens dependentes e protótipos de item é 29999. Property behavior: - required se type estiver definido como "Dependent item"- read-only para objetos herdados |
| output_format | integer | A resposta deve ser convertida para JSON. Valores possíveis: 0 - (default) Armazenar bruto; 1 - Converter para JSON. Property behavior: - supported se type estiver definido como "HTTP agent"- read-only 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. Property behavior: - required se type estiver definido como "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script" ou "Browser"- read-only 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". Array de objetos com propriedades name e value, em que name deve ser único.Property behavior: - supported se type estiver definido como "Script" ou "Browser"- read-only para objetos herdados |
| password | string | Senha para autenticação. Property behavior: - required se type estiver definido como "JMX agent" e username estiver definido- supported se type estiver definido como "Simple check", "SSH agent", "TELNET agent", "Database monitor" ou "HTTP agent"- read-only para objetos herdados (se type estiver definido como "HTTP agent") |
| post_type | integer | Tipo do corpo dos dados de post armazenado na propriedade posts.Valores possíveis: 0 - (default) Dados brutos; 2 - Dados JSON; 3 - Dados XML. Property behavior: - supported se type estiver definido como "HTTP agent"- read-only para objetos herdados |
| posts | string | Dados do corpo da solicitação HTTP(S). Property behavior: - required se type estiver definido como "HTTP agent" e post_type estiver definido como "JSON data" ou "XML data"- supported se type estiver definido como "HTTP agent" e post_type estiver definido como "Raw data"- read-only para objetos herdados |
| privatekey | string | Nome do arquivo da chave privada. Property behavior: - required se type estiver definido como "SSH agent" e authtype estiver definido como "public key" |
| publickey | string | Nome do arquivo da chave pública. Property behavior: - required se type estiver definido como "SSH agent" e authtype estiver definido como "public key" |
| query_fields | array | Array de query fields que serão enviados ao executar uma solicitação HTTP. Property behavior: - supported se type estiver definido como "HTTP agent"- read-only para objetos herdados |
| request_method | integer | Tipo do método de solicitação. Valores possíveis: 0 - (default) GET; 1 - POST; 2 - PUT; 3 - HEAD. Property behavior: - supported se type estiver definido como "HTTP agent"- read-only para objetos herdados |
| retrieve_mode | integer | Qual parte da resposta deve ser armazenada. Valores possíveis se request_method estiver definido como "GET", "POST" ou "PUT":0 - (default) Body; 1 - Headers; 2 - Tanto o body quanto os headers serão armazenados. Valores possíveis se request_method estiver definido como "HEAD":1 - Headers. Property behavior: - supported se type estiver definido como "HTTP agent"- read-only para objetos herdados |
| snmp_oid | string | OID SNMP. Property behavior: - required se type estiver definido como "SNMP agent"- read-only para objetos herdados |
| ssl_cert_file | string | Caminho do arquivo da chave SSL pública. Property behavior: - supported se type estiver definido como "HTTP agent"- read-only para objetos herdados |
| ssl_key_file | string | Caminho do arquivo da chave SSL privada. Property behavior: - supported se type estiver definido como "HTTP agent"- read-only para objetos herdados |
| ssl_key_password | string | Senha do arquivo da chave SSL. Property behavior: - supported se type estiver definido como "HTTP agent"- read-only para objetos herdados |
| status | integer | Status do protótipo de item. Valores possíveis: 0 - (default) protótipo de item habilitado; 1 - protótipo de item desabilitado; 3 - protótipo de item sem suporte. |
| status_codes | string | Intervalos dos códigos de status HTTP necessários, separados por vírgulas. Também suporta macros de usuário ou macros LLD como parte de uma lista separada por vírgulas. Exemplo: 200,200-{$M},{$M},200-400 Property behavior: - supported se type estiver definido como "HTTP agent"- read-only para objetos herdados |
| templateid | ID | ID do protótipo de item do template pai. Property behavior: - read-only |
| timeout | string | Tempo limite da solicitaçã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. Intervalo de valores possível: 1-600s. Default: "" - usar configurações do proxy/global. Property behavior: - supported 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)- read-only para objetos herdados |
| trapper_hosts | string | Hosts permitidos. Property behavior: - supported 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 | Uma unidade de tempo que define por quanto tempo os dados de tendências devem ser armazenados. Também aceita macro de usuário e macro LLD. Default: 365d. Property behavior: - supported se value_type estiver definido como "numeric float" ou "numeric unsigned" |
| units | string | Unidades do valor. Property behavior: - supported se value_type estiver definido como "numeric float" ou "numeric unsigned"- read-only para objetos herdados |
| username | string | Nome de usuário para autenticação. Property behavior: - required se type estiver definido como "SSH agent" ou "TELNET agent", ou se type estiver definido como "JMX agent" e password estiver definido- supported se type estiver definido como "Simple check", "Database monitor" ou "HTTP agent"- read-only para objetos herdados (se type estiver definido como "HTTP agent") |
| uuid | string | Identificador único universal, usado para vincular protótipos de item importados a protótipos já existentes. Gerado automaticamente, se não for fornecido. Property behavior: - supported se o protótipo de item pertencer a um template |
| valuemapid | ID | ID do mapa de valores associado. Property behavior: - supported se value_type estiver definido como "numeric float", "character" ou "numeric unsigned"- read-only para objetos herdados |
| verify_host | integer | Se deve validar que o nome do host para a conexão corresponde ao nome no certificado do host. Valores possíveis: 0 - (default) Não validar; 1 - Validar. Property behavior: - supported se type estiver definido como "HTTP agent"- read-only para objetos herdados |
| verify_peer | integer | Se deve validar que o certificado do host é autêntico. Valores possíveis: 0 - (default) Não validar; 1 - Validar. Property behavior: - supported se type estiver definido como "HTTP agent"- read-only para objetos herdados |
| discover | integer | Status de descoberta do protótipo de item. Valores possíveis: 0 - (default) 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 item prototype
O objeto de pré-processamento do item prototype tem as seguintes propriedades.
| Property | Type | Description |
|---|---|---|
| type | integer | O tipo da 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 - 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 de walk SNMP; 29 - Walk SNMP para JSON; 30 - Obter valor SNMP. Comportamento da propriedade: - required |
| 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 "Check unsupported", 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: - required se type estiver definido como "Custom multiplier" (1), "Right trim" (2), "Left trim" (3), "Trim" (4), "Regular expression" (5), "XML XPath" (11), "JSONPath" (12), "In range" (13), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Check for error using regular expression" (18), "Discard unchanged with heartbeat" (20), "JavaScript" (21), "Prometheus pattern" (22), "Prometheus to JSON" (23), "CSV to JSON" (24), "Replace" (25), "Check unsupported" (26), "SNMP walk value" (28), "SNMP walk to JSON" (29), ou "SNMP get value" (30) |
| error_handler | integer | Tipo de ação usado em caso de falha na 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 "Check unsupported":1 - Descartar valor; 2 - Definir valor personalizado; 3 - Definir mensagem de erro personalizada. Comportamento da propriedade: - required se type estiver definido como "Custom multiplier" (1), "Regular expression" (5), "Boolean to decimal" (6), "Octal to decimal" (7), "Hexadecimal to decimal" (8), "Simple change" (9), "Change per second" (10), "XML XPath" (11), "JSONPath" (12), "In range" (13), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Check for error using regular expression" (18), "Prometheus pattern" (22), "Prometheus to JSON" (23), "CSV to JSON" (24), "Check unsupported" (26), "XML to JSON" (27), "SNMP walk value" (28), "SNMP walk to JSON" (29), ou "SNMP get value" (30) |
| error_handler_params | string | Parâmetros do manipulador de erro. Comportamento da propriedade: - required se error_handler estiver definido como "Set custom value" ou "Set custom error message" |
Os seguintes parâmetros e manipuladores de erro são suportados para cada tipo de pré-processamento.
| Preprocessing type | Name | Parameter 1 | Parameter 2 | Parameter 3 | Supported error handlers |
|---|---|---|---|---|---|
| 1 | Custom multiplier | number1, 6 | 0, 1, 2, 3 | ||
| 2 | Right trim | list of characters2 | |||
| 3 | Left trim | list of characters2 | |||
| 4 | Trim | list of characters2 | |||
| 5 | Regular expression | pattern3 | output2 | 0, 1, 2, 3 | |
| 6 | Boolean to decimal | 0, 1, 2, 3 | |||
| 7 | Octal to decimal | 0, 1, 2, 3 | |||
| 8 | Hexadecimal to decimal | 0, 1, 2, 3 | |||
| 9 | Simple change | 0, 1, 2, 3 | |||
| 10 | Change per second | 0, 1, 2, 3 | |||
| 11 | XML XPath | path4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | path4 | 0, 1, 2, 3 | ||
| 13 | In range | min1, 6 | max1, 6 | 0, 1, 2, 3 | |
| 14 | Matches regular expression | pattern3 | 0, 1, 2, 3 | ||
| 15 | Does not match regular expression | pattern3 | 0, 1, 2, 3 | ||
| 16 | Check for error in JSON | path4 | 0, 1, 2, 3 | ||
| 17 | Check for error in XML | path4 | 0, 1, 2, 3 | ||
| 18 | Check for error using regular expression | pattern3 | output2 | 0, 1, 2, 3 | |
| 19 | Discard unchanged | ||||
| 20 | Discard unchanged with heartbeat | seconds5, 6 | |||
| 21 | JavaScript | script2 | |||
| 22 | Prometheus pattern | pattern6, 7 | value, label, function |
output8, 9 | 0, 1, 2, 3 |
| 23 | Prometheus to JSON | pattern6, 7 | 0, 1, 2, 3 | ||
| 24 | CSV to JSON | character2 | character2 | 0,1 | 0, 1, 2, 3 |
| 25 | Replace | search string2 | replacement2 | ||
| 26 | Check unsupported | scope1 | pattern3, 6 | 1, 2, 3 | |
| 27 | XML to JSON | 0, 1, 2, 3 | |||
| 28 | SNMP walk value | OID2 | Format: 0 - Unchanged 1 - UTF-8 from Hex-STRING 2 - MAC from Hex-STRING 3 - Integer from BITS |
0, 1, 2, 3 | |
| 29 | SNMP walk to JSON10 | Field name2 | OID prefix2 | Format: 0 - Unchanged 1 - UTF-8 from Hex-STRING 2 - MAC from Hex-STRING 3 - Integer from BITS |
0, 1, 2, 3 |
| 30 | SNMP get value | Format: 1 - UTF-8 from Hex-STRING 2 - MAC from Hex-STRING 3 - Integer from 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 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:
<metric name>{<label name>="<label value>", ...} == <value>. Cada
componente do padrão Prometheus (métrica, nome do rótulo, valor do rótulo e valor da métrica)
pode ser macro de usuário ou macro LLD.
8 saída Prometheus seguindo a sintaxe: <label name> (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 vários registros "Field name,OID prefix,Format" delimitados por um caractere de nova linha.