Oggetto prototipo di elemento
I seguenti oggetti sono direttamente correlati all'API itemprototype.
Prototipo di item
L'oggetto prototipo di item ha le seguenti proprietà.
| Proprietà | Tipo | Descrizione |
|---|---|---|
| itemid | ID | ID del prototipo di item. Comportamento della proprietà: - sola lettura - obbligatoria per le operazioni di aggiornamento |
| delay | string | Intervallo di aggiornamento del prototipo di item. Accetta secondi o un'unità di tempo con suffisso (ad esempio, 30s, 1m, 2h, 1d) e, facoltativamente, uno o più intervalli personalizzati, tutti separati da punto e virgola. Gli intervalli personalizzati possono essere una combinazione di intervalli flessibili e pianificati. Accetta macro utente e macro LLD. Se utilizzato, il valore deve essere una singola macro. Macro multiple o macro combinate con testo non sono supportate. Gli intervalli flessibili possono essere scritti come due macro separate da una barra (ad esempio, {$FLEX_INTERVAL}/{$FLEX_PERIOD}).Esempio: 1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}Comportamento della proprietà: - obbligatoria se type è impostato su "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), oppure se type è impostato su "Zabbix agent (active)" (7) e key_ non contiene "mqtt.get" |
| hostid | ID | ID del host a cui appartiene il prototipo di item. Comportamento della proprietà: - costante - obbligatoria per le operazioni di creazione |
| interfaceid | ID | ID dell'interfaccia del host del prototipo di item. Comportamento della proprietà: - obbligatoria se il prototipo di item appartiene a un host e type è impostato su "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap" o "SNMP agent"- supportata se il prototipo di item appartiene a un host e type è impostato su "Simple check", "External check", "SSH agent", "TELNET agent" o "HTTP agent" |
| key_ | string | Chiave del prototipo di item. Comportamento della proprietà: - obbligatoria per le operazioni di creazione - sola lettura per gli oggetti ereditati |
| name | string | Nome del prototipo di item. Supporta macro utente. Comportamento della proprietà: - obbligatoria per le operazioni di creazione - sola lettura per gli oggetti ereditati |
| type | integer | Tipo del prototipo di item. Valori possibili: 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 - item dipendente; 19 - HTTP agent; 20 - SNMP agent; 21 - Script; 22 - Browser. Comportamento della proprietà: - obbligatoria per le operazioni di creazione - sola lettura per gli oggetti ereditati |
| url | string | Stringa URL. Supporta macro LLD, macro utente, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}. Comportamento della proprietà: - obbligatoria se type è impostato su "HTTP agent"- sola lettura per gli oggetti ereditati |
| value_type | integer | Tipo di informazione del prototipo di item. Valori possibili: 0 - numerico in virgola mobile; 1 - carattere; 2 - log; 3 - numerico senza segno; 4 - testo; 5 - binario; 6 - JSON. Comportamento della proprietà: - obbligatoria per le operazioni di creazione - sola lettura per gli oggetti ereditati |
| allow_traps | integer | Consente di popolare il valore in modo simile a un item trapper. 0 - (predefinito) Non consentire l'accettazione di dati in ingresso; 1 - Consentire l'accettazione di dati in ingresso. Comportamento della proprietà: - supportata se type è impostato su "HTTP agent" |
| authtype | integer | Metodo di autenticazione. Valori possibili se type è impostato su "SSH agent":0 - (predefinito) password; 1 - chiave pubblica. Valori possibili se type è impostato su "HTTP agent":0 - (predefinito) nessuno; 1 - basic; 2 - NTLM; 3 - Kerberos; 4 - Digest. Comportamento della proprietà: - supportata se type è impostato su "SSH agent" o "HTTP agent"- sola lettura per gli oggetti ereditati (se type è impostato su "HTTP agent") |
| description | string | Descrizione del prototipo di item. |
| flags | integer | Origine del prototipo di item. Valori possibili: 2 - un prototipo di item; 6 - un prototipo di item individuato automaticamente Comportamento della proprietà: - sola lettura |
| follow_redirects | integer | Segue i reindirizzamenti della risposta durante il polling dei dati. Valori possibili: 0 - Non seguire i reindirizzamenti; 1 - (predefinito) Seguire i reindirizzamenti. Comportamento della proprietà: - supportata se type è impostato su "HTTP agent"- sola lettura per gli oggetti ereditati |
| headers | array | Array di header HTTP che verranno inviati durante l'esecuzione di una richiesta HTTP. Comportamento della proprietà: - supportata se type è impostato su "HTTP agent"- sola lettura per gli oggetti ereditati |
| history | string | Unità di tempo che definisce per quanto tempo devono essere conservati i dati storici. Accetta anche macro utente e macro LLD. Predefinito: 31d. |
| http_proxy | string | Stringa di connessione del proxy HTTP(S). Comportamento della proprietà: - supportata se type è impostato su "HTTP agent"- sola lettura per gli oggetti ereditati |
| ipmi_sensor | string | Sensore IPMI. Comportamento della proprietà: - obbligatoria se type è impostato su "IPMI agent" e key_ non è impostato su "ipmi.get"- supportata se type è impostato su "IPMI agent"- sola lettura per gli oggetti ereditati |
| jmx_endpoint | string | Stringa di connessione personalizzata di JMX agent. Predefinito: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi Comportamento della proprietà: - supportata se type è impostato su "JMX agent" |
| logtimefmt | string | Formato dell'ora nelle voci di log. Comportamento della proprietà: - supportata se value_type è impostato su "log"- sola lettura per gli oggetti ereditati |
| master_itemid | ID | ID del master item. Comportamento della proprietà: - obbligatoria se type è impostato su "Dependent item"- sola lettura per gli oggetti ereditati |
| output_format | integer | Indica se la risposta deve essere convertita in JSON. Valori possibili: 0 - (predefinito) Memorizza il dato grezzo; 1 - Converti in JSON. Comportamento della proprietà: - supportata se type è impostato su "HTTP agent"- sola lettura per gli oggetti ereditati |
| params | string | Parametri aggiuntivi in base al tipo di prototipo di item: - script eseguito per i prototipi di item SSH agent e TELNET agent; - query SQL per i prototipi di item database monitor; - formula per i prototipi di item calculated; - lo script per i prototipi di item script e browser. Comportamento della proprietà: - obbligatoria se type è impostato su "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script" o "Browser"- sola lettura per gli oggetti ereditati (se type è impostato su "Script" o "Browser") |
| parameters | object/array | Parametri aggiuntivi se type è impostato su "Script" o "Browser". Array di oggetti con proprietà name e value, dove name deve essere univoco.Comportamento della proprietà: - supportata se type è impostato su "Script" o "Browser"- sola lettura per gli oggetti ereditati |
| password | string | Password per l'autenticazione. Comportamento della proprietà: - obbligatoria se type è impostato su "JMX agent" e username è impostato- supportata se type è impostato su "Simple check", "SSH agent", "TELNET agent", "Database monitor" o "HTTP agent"- sola lettura per gli oggetti ereditati (se type è impostato su "HTTP agent") |
| post_type | integer | Tipo del corpo dei dati POST memorizzato nella proprietà posts.Valori possibili: 0 - (predefinito) Dati grezzi. 2 - Dati JSON. 3 - Dati XML. Comportamento della proprietà: - supportata se type è impostato su "HTTP agent"- sola lettura per gli oggetti ereditati |
| posts | string | Dati del corpo della richiesta HTTP(S). Comportamento della proprietà: - obbligatoria se type è impostato su "HTTP agent" e post_type è impostato su "JSON data" o "XML data"- supportata se type è impostato su "HTTP agent" e post_type è impostato su "Raw data"- sola lettura per gli oggetti ereditati |
| privatekey | string | Nome del file della chiave privata. Comportamento della proprietà: - obbligatoria se type è impostato su "SSH agent" e authtype è impostato su "public key" |
| publickey | string | Nome del file della chiave pubblica. Comportamento della proprietà: - obbligatoria se type è impostato su "SSH agent" e authtype è impostato su "public key" |
| query_fields | array | Array di campi di query che verranno inviati durante l'esecuzione di una richiesta HTTP. Comportamento della proprietà: - supportata se type è impostato su "HTTP agent"- sola lettura per gli oggetti ereditati |
| request_method | integer | Tipo di metodo della richiesta. Valori possibili: 0 - (predefinito) GET; 1 - POST; 2 - PUT; 3 - HEAD. Comportamento della proprietà: - supportata se type è impostato su "HTTP agent"- sola lettura per gli oggetti ereditati |
| retrieve_mode | integer | Quale parte della risposta deve essere memorizzata. Valori possibili se request_method è impostato su "GET", "POST" o "PUT":0 - (predefinito) Corpo; 1 - Header; 2 - Verranno memorizzati sia il corpo sia gli header. Valori possibili se request_method è impostato su "HEAD":1 - Header. Comportamento della proprietà: - supportata se type è impostato su "HTTP agent"- sola lettura per gli oggetti ereditati |
| snmp_oid | string | OID SNMP. Comportamento della proprietà: - obbligatoria se type è impostato su "SNMP agent"- sola lettura per gli oggetti ereditati |
| ssl_cert_file | string | Percorso del file della chiave SSL pubblica. Comportamento della proprietà: - supportata se type è impostato su "HTTP agent"- sola lettura per gli oggetti ereditati |
| ssl_key_file | string | Percorso del file della chiave SSL privata. Comportamento della proprietà: - supportata se type è impostato su "HTTP agent"- sola lettura per gli oggetti ereditati |
| ssl_key_password | string | Password per il file della chiave SSL. Comportamento della proprietà: - supportata se type è impostato su "HTTP agent"- sola lettura per gli oggetti ereditati |
| status | integer | Stato del prototipo di item. Valori possibili: 0 - (predefinito) prototipo di item abilitato; 1 - prototipo di item disabilitato; 3 - prototipo di item non supportato. |
| status_codes | string | Intervalli dei codici di stato HTTP richiesti, separati da virgole. Supporta anche macro utente o macro LLD come parte di un elenco separato da virgole. Esempio: 200,200-{$M},{$M},200-400 Comportamento della proprietà: - supportata se type è impostato su "HTTP agent"- sola lettura per gli oggetti ereditati |
| templateid | ID | ID del prototipo di item del template padre. Comportamento della proprietà: - sola lettura |
| timeout | string | Timeout della richiesta di polling dei dati dell'item. Accetta secondi o un'unità di tempo con suffisso (ad esempio, 30s, 1m). Accetta anche macro utente e macro LLD. Intervallo di valori possibile: 1-600s. Predefinito: "" - usa le impostazioni globali/del proxy. Comportamento della proprietà: - supportata se type è impostato su "Zabbix agent" (0), "Simple check" (3) e key_ non inizia con "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 inizia con "walk[" o "get[", "Script" (21), "Browser" (22)- sola lettura per gli oggetti ereditati |
| trapper_hosts | string | host consentiti. Comportamento della proprietà: - supportata se type è impostato su "Zabbix trapper", oppure se type è impostato su "HTTP agent" e allow_traps è impostato su "Allow to accept incoming data" |
| trends | string | Unità di tempo che definisce per quanto tempo devono essere conservati i dati di trend. Accetta anche macro utente e macro LLD. Predefinito: 365d. Comportamento della proprietà: - supportata se value_type è impostato su "numeric float" o "numeric unsigned" |
| units | string | Unità del valore. Comportamento della proprietà: - supportata se value_type è impostato su "numeric float" o "numeric unsigned"- sola lettura per gli oggetti ereditati |
| username | string | Nome utente per l'autenticazione. Comportamento della proprietà: - obbligatoria se type è impostato su "SSH agent" o "TELNET agent", oppure se type è impostato su "JMX agent" e password è impostato- supportata se type è impostato su "Simple check", "Database monitor" o "HTTP agent"- sola lettura per gli oggetti ereditati (se type è impostato su "HTTP agent") |
| uuid | string | Identificatore univoco universale, utilizzato per collegare i prototipi di item importati a quelli già esistenti. Generato automaticamente, se non fornito. Comportamento della proprietà: - supportata se il prototipo di item appartiene a un template |
| valuemapid | ID | ID della mappa dei valori associata. Comportamento della proprietà: - supportata se value_type è impostato su "numeric float", "character" o "numeric unsigned"- sola lettura per gli oggetti ereditati |
| verify_host | integer | Indica se verificare che il nome del host per la connessione corrisponda a quello nel certificato del host. Valori possibili: 0 - (predefinito) Non verificare; 1 - Verificare. Comportamento della proprietà: - supportata se type è impostato su "HTTP agent"- sola lettura per gli oggetti ereditati |
| verify_peer | integer | Indica se verificare che il certificato del host sia autentico. Valori possibili: 0 - (predefinito) Non verificare; 1 - Verificare. Comportamento della proprietà: - supportata se type è impostato su "HTTP agent"- sola lettura per gli oggetti ereditati |
| discover | integer | Stato di individuazione del prototipo di item. Valori possibili: 0 - (predefinito) i nuovi item verranno individuati; 1 - i nuovi item non verranno individuati e gli item esistenti verranno contrassegnati come persi. |
Intestazione HTTP
L'oggetto header ha le seguenti proprietà:
| Proprietà | Tipo | Descrizione |
|---|---|---|
| name | string | Nome dell'intestazione HTTP. Comportamento della proprietà: - obbligatorio |
| value | string | Valore dell'intestazione. Comportamento della proprietà: - obbligatorio |
Campo di query HTTP
L'oggetto campo di query definisce un nome e un valore utilizzati per specificare un parametro URL. Ha le seguenti proprietà:
| Proprietà | Type | Descrizione |
|---|---|---|
| name | string | Nome del parametro. Comportamento della proprietà: - obbligatorio |
| value | string | Valore del parametro. Comportamento della proprietà: - obbligatorio |
Tag del prototipo di item
L'oggetto tag del prototipo di item ha le seguenti proprietà.
| Proprietà | Tipo | Descrizione |
|---|---|---|
| tag | string | Nome del tag del prototipo di item. Comportamento della proprietà: - obbligatorio |
| value | string | Valore del tag del prototipo di item. Comportamento della proprietà: - sola lettura. |
| object | integer | Tipo di oggetto da cui il tag è stato ereditato. Valori possibili: 0 - template; 1 - host. Comportamento della proprietà: - sola lettura. |
| objectid | ID | ID dell'oggetto da cui il tag è stato ereditato. Comportamento della proprietà: - sola lettura. |
Pre-elaborazione del prototipo di item
L'oggetto di pre-elaborazione del prototipo di item ha le seguenti proprietà.
| Property | Type | Description |
|---|---|---|
| type | integer | Il tipo di opzione di pre-elaborazione. Valori possibili: 1 - Moltiplicatore personalizzato; 2 - Taglio a destra; 3 - Taglio a sinistra; 4 - Taglio; 5 - Espressione regolare; 6 - Booleano in decimale; 7 - Ottale in decimale; 8 - Esadecimale in decimale; 9 - Variazione semplice; 10 - Variazione al secondo; 11 - XML XPath; 12 - JSONPath; 13 - Nell'intervallo; 14 - Corrisponde all'espressione regolare; 15 - Non corrisponde all'espressione regolare; 16 - Controlla errore in JSON; 17 - Controlla errore in XML; 18 - Controlla errore usando un'espressione regolare; 19 - Scarta se invariato; 20 - Scarta se invariato con heartbeat; 21 - JavaScript; 22 - Pattern Prometheus; 23 - Prometheus in JSON; 24 - CSV in JSON; 25 - Sostituisci; 26 - Controlla non supportato; 27 - XML in JSON; 28 - Valore SNMP walk; 29 - SNMP walk in JSON; 30 - Valore SNMP get. Property behavior: - required |
| params | string | Parametri aggiuntivi usati dall'opzione di pre-elaborazione. I parametri multipli sono separati dal carattere newline (\n). Se type è impostato su "Check unsupported", i parametri seguono la sintassi <scope>[\n<pattern>], dove pattern è un'espressione regolare e scope è uno dei seguenti:-1 - corrisponde a qualsiasi errore; \ 0 - controlla se il messaggio di errore corrisponde a pattern; \ 1 - controlla se il messaggio di errore non corrisponde a pattern. Property behavior: - required se type è impostato su "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) o "SNMP get value" (30) |
| error_handler | integer | Tipo di azione usato in caso di errore del passaggio di pre-elaborazione. Valori possibili: 0 - Il messaggio di errore è impostato da Zabbix server; 1 - Scarta valore; 2 - Imposta valore personalizzato; 3 - Imposta messaggio di errore personalizzato. Valori possibili se type è impostato su "Check unsupported":1 - Scarta valore; 2 - Imposta valore personalizzato; 3 - Imposta messaggio di errore personalizzato. Property behavior: - required se type è impostato su "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) o "SNMP get value" (30) |
| error_handler_params | string | Parametri del gestore errori. Property behavior: - required se error_handler è impostato su "Set custom value" o "Set custom error message" |
I seguenti parametri e gestori errori sono supportati per ciascun tipo di pre-elaborazione.
| Preprocessing type | Name | Parameter 1 | Parameter 2 | Parameter 3 | Supported error handlers |
|---|---|---|---|---|---|
| 1 | Moltiplicatore personalizzato | numero1,\ 6 | 0, 1, 2, 3 | ||
| 2 | Taglio a destra | elenco di caratteri2 | |||
| 3 | Taglio a sinistra | elenco di caratteri2 | |||
| 4 | Taglio | elenco di caratteri2 | |||
| 5 | Espressione regolare | pattern3 | output2 | 0, 1, 2, 3 | |
| 6 | Booleano in decimale | 0, 1, 2, 3 | |||
| 7 | Ottale in decimale | 0, 1, 2, 3 | |||
| 8 | Esadecimale in decimale | 0, 1, 2, 3 | |||
| 9 | Variazione semplice | 0, 1, 2, 3 | |||
| 10 | Variazione al secondo | 0, 1, 2, 3 | |||
| 11 | XML XPath | percorso4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | percorso4 | 0, 1, 2, 3 | ||
| 13 | Nell'intervallo | min1,\ 6 | max1,\ 6 | 0, 1, 2, 3 | |
| 14 | Corrisponde all'espressione regolare | pattern3 | 0, 1, 2, 3 | ||
| 15 | Non corrisponde all'espressione regolare | pattern3 | 0, 1, 2, 3 | ||
| 16 | Controlla errore in JSON | percorso4 | 0, 1, 2, 3 | ||
| 17 | Controlla errore in XML | percorso4 | 0, 1, 2, 3 | ||
| 18 | Controlla errore usando un'espressione regolare | pattern3 | output2 | 0, 1, 2, 3 | |
| 19 | Scarta se invariato | ||||
| 20 | Scarta se invariato con heartbeat | secondi5,\ 6 | |||
| 21 | JavaScript | script2 | |||
| 22 | Pattern Prometheus | pattern6,\ 7 | value, label, function |
output8,\ 9 | 0, 1, 2, 3 |
| 23 | Prometheus in JSON | pattern6,\ 7 | 0, 1, 2, 3 | ||
| 24 | CSV in JSON | carattere2 | carattere2 | 0,1 | 0, 1, 2, 3 |
| 25 | Sostituisci | stringa di ricerca2 | sostituzione2 | ||
| 26 | Controlla non supportato | scope1 | pattern3,\ 6 | 1, 2, 3 | |
| 27 | XML in JSON | 0, 1, 2, 3 | |||
| 28 | Valore SNMP walk | OID2 | Formato: 0 - Invariato 1 - UTF-8 da Hex-STRING 2 - MAC da Hex-STRING 3 - Intero da BITS |
0, 1, 2, 3 | |
| 29 | SNMP walk in JSON10 | Nome campo2 | Prefisso OID2 | Formato: 0 - Invariato 1 - UTF-8 da Hex-STRING 2 - MAC da Hex-STRING 3 - Intero da BITS |
0, 1, 2, 3 |
| 30 | Valore SNMP get | Formato: 1 - UTF-8 da Hex-STRING 2 - MAC da Hex-STRING 3 - Intero da BITS |
0, 1, 2, 3 | ||
1 numero intero o in virgola mobile
2 stringa
3 espressione regolare
4 JSONPath o XML XPath
5 intero positivo (con supporto dei suffissi temporali, ad esempio 30s, 1m, 2h, 1d)
6 macro utente, macro LLD
7 Pattern Prometheus che segue la sintassi: <metric name>{<label name>="<label value>", ...} == <value>.
Ogni componente del pattern Prometheus (metrica, nome etichetta, valore etichetta e valore della metrica) può essere una macro utente o una macro LLD.
8 Output Prometheus che segue la sintassi: <label name> (può essere una macro utente o una macro LLD) se label è selezionato come secondo parametro.
9 Una delle funzioni di aggregazione: sum, min, max, avg, count se function è selezionato come secondo parametro.
10 Supporta più record "Nome campo,Prefisso OID,Formato" delimitati da un carattere di nuova riga.