Oggetto elemento

I seguenti oggetti sono direttamente correlati all'API item.

Item

Gli item web non possono essere creati, aggiornati o eliminati direttamente tramite la Zabbix API.

L'oggetto item ha le seguenti proprietà.

Property Type Description
itemid ID ID dell'item.

Property behavior:
- sola lettura
- obbligatorio per le operazioni di aggiornamento
delay string Intervallo di aggiornamento dell'item.

Accetta secondi o 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 di pianificazione.

Accetta macro utente. Se utilizzato, il valore deve essere una singola macro. Non sono supportate più macro o macro mescolate con testo. Gli intervalli flessibili possono essere scritti come due macro separate da una barra obliqua (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}

Property behavior:
- obbligatorio 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 dell'host o del template a cui appartiene l'item.

Property behavior:
- costante
- obbligatorio per le operazioni di creazione
interfaceid ID ID dell'interfaccia host dell'item.

Property behavior:
- obbligatorio se l'item appartiene a un host e type è impostato su "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap" o "SNMP agent"
- supportato se l'item appartiene a un host e type è impostato su "Simple check", "External check", "SSH agent", "TELNET agent" o "HTTP agent"
- sola lettura per gli oggetti rilevati
key_ string Chiave dell'item.

Property behavior:
- obbligatorio per le operazioni di creazione
- sola lettura per gli oggetti ereditati o rilevati
name string Nome dell'item.
Supporta le macro utente.

Property behavior:
- obbligatorio per le operazioni di creazione
- sola lettura per gli oggetti ereditati o rilevati
name_resolved string Nome dell'item con le macro utente risolte.

Property behavior:
- sola lettura
type integer Tipo dell'item.

Valori possibili:
0 - Zabbix agent;
2 - Zabbix trapper;
3 - Simple check;
5 - Zabbix internal;
7 - Zabbix agent (active);
9 - Web item;
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:
- obbligatorio per le operazioni di creazione
- sola lettura per gli oggetti ereditati o rilevati
url string Stringa URL.
Supporta le macro utente, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}.

Property behavior:
- obbligatorio se type è impostato su "HTTP agent"
- sola lettura per gli oggetti ereditati o rilevati
value_type integer Tipo di informazione dell'item.

Valori possibili:
0 - numeric float;
1 - character;
2 - log;
3 - numeric unsigned;
4 - text;
5 - binary;
6 - JSON.

Property behavior:
- obbligatorio per le operazioni di creazione
- sola lettura per gli oggetti ereditati o rilevati
allow_traps integer Consente di popolare il valore in modo simile all'item trapper.

0 - (predefinito) Non consentire l'accettazione di dati in ingresso;
1 - Consentire l'accettazione di dati in ingresso.

Property behavior:
- supportato se type è impostato su "HTTP agent"
- sola lettura per gli oggetti rilevati
authtype integer Metodo di autenticazione.

Valori possibili se type è impostato su "SSH agent":
0 - (predefinito) password;
1 - public key.

Valori possibili se type è impostato su "HTTP agent":
0 - (predefinito) none;
1 - basic;
2 - NTLM;
3 - Kerberos;
4 - Digest.

Property behavior:
- supportato se type è impostato su "SSH agent" o "HTTP agent"
- sola lettura per gli oggetti ereditati (se type è impostato su "HTTP agent") o rilevati
description string Descrizione dell'item.

Property behavior:
- sola lettura per gli oggetti rilevati
error string Testo di errore se si verificano problemi durante l'aggiornamento del valore dell'item.

Property behavior:
- sola lettura
flags integer Origine dell'item.

Valori possibili:
0 - un item normale;
4 - un item convertito da prototipo.

Property behavior:
- sola lettura
follow_redirects integer Segui i reindirizzamenti della risposta durante il polling dei dati.

Valori possibili:
0 - Non seguire i reindirizzamenti;
1 - (predefinito) Segui i reindirizzamenti.

Property behavior:
- supportato se type è impostato su "HTTP agent"
- sola lettura per gli oggetti ereditati o rilevati
headers array Array di header che verranno inviati durante l'esecuzione di una richiesta HTTP.

Property behavior:
- supportato se type è impostato su "HTTP agent"
- sola lettura per gli oggetti ereditati o rilevati
history string Unità di tempo per la durata di conservazione dei dati storici.
Accetta anche macro utente.

Predefinito: 31d.

Property behavior:
- sola lettura per gli oggetti rilevati
http_proxy string Stringa di connessione del proxy HTTP(S).

Property behavior:
- supportato se type è impostato su "HTTP agent"
- sola lettura per gli oggetti ereditati o rilevati
inventory_link integer ID del campo dell'inventario host popolato dall'item.

Consultare la pagina dell'inventario host per un elenco dei campi inventario host supportati e dei relativi ID.

Predefinito: 0.

Property behavior:
- supportato se value_type è impostato su "numeric float", "character", "numeric unsigned" o "text"
- sola lettura per gli oggetti rilevati
ipmi_sensor string Sensore IPMI.

Property behavior:
- obbligatorio se type è impostato su "IPMI agent" e key_ non è impostato su "ipmi.get"
- supportato se type è impostato su "IPMI agent"
- sola lettura per gli oggetti ereditati o rilevati
jmx_endpoint string Stringa di connessione personalizzata dell'agent JMX.

Valore predefinito: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi

Property behavior:
- supportato se type è impostato su "JMX agent"
- sola lettura per gli oggetti rilevati
lastclock timestamp Ora dell'ultimo aggiornamento del valore dell'item.

Per impostazione predefinita, vengono visualizzati solo i valori rientranti nelle ultime 24 ore. È possibile estendere questo intervallo modificando il parametro Max history display period nella sezione di menu Administration > General.

Property behavior:
- sola lettura
lastns integer Nanosecondi dell'ultimo aggiornamento del valore dell'item.

Per impostazione predefinita, vengono visualizzati solo i valori rientranti nelle ultime 24 ore. È possibile estendere questo intervallo modificando il parametro Max history display period nella sezione di menu Administration > General.

Property behavior:
- sola lettura
lastvalue string Ultimo valore dell'item.

Per impostazione predefinita, vengono visualizzati solo i valori rientranti nelle ultime 24 ore. È possibile estendere questo intervallo modificando il parametro Max history display period nella sezione di menu Administration > General.

Property behavior:
- sola lettura
logtimefmt string Formato dell'ora nelle voci di log.

Property behavior:
- supportato se value_type è impostato su "log"
- sola lettura per gli oggetti ereditati o rilevati
master_itemid ID ID dell'item master.

Property behavior:
- obbligatorio se type è impostato su "Dependent item"
- sola lettura per gli oggetti ereditati o rilevati
output_format integer Indica se la risposta deve essere convertita in JSON.

0 - (predefinito) Memorizza i dati grezzi;
1 - Converti in JSON.

Property behavior:
- supportato se type è impostato su "HTTP agent"
- sola lettura per gli oggetti ereditati o rilevati
params string Parametri aggiuntivi a seconda del tipo di item:
- script eseguito per gli item SSH agent e TELNET agent;
- query SQL per gli item database monitor;
- formula per gli item calculated;
- script per gli item script e browser.

Property behavior:
- obbligatorio 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") o rilevati
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.

Property behavior:
- supportato se type è impostato su "Script" o "Browser"
- sola lettura per gli oggetti ereditati o rilevati
password string Password per l'autenticazione.

Property behavior:
- obbligatorio se type è impostato su "JMX agent" e username è impostato
- supportato 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") o rilevati
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.

Property behavior:
- supportato se type è impostato su "HTTP agent"
- sola lettura per gli oggetti ereditati o rilevati
posts string Dati del corpo della richiesta HTTP(S).

Property behavior:
- obbligatorio se type è impostato su "HTTP agent" e post_type è impostato su "Dati JSON" o "Dati XML"
- supportato se type è impostato su "HTTP agent" e post_type è impostato su "Dati grezzi"
- sola lettura per gli oggetti ereditati o rilevati
prevvalue string Valore precedente dell'item.

Per impostazione predefinita, vengono visualizzati solo i valori rientranti nelle ultime 24 ore. È possibile estendere questo intervallo modificando il parametro Max history display period nella sezione di menu Administration > General.

Property behavior:
- sola lettura
privatekey string Nome del file della chiave privata.

Property behavior:
- obbligatorio se type è impostato su "SSH agent" e authtype è impostato su "public key"
- sola lettura per gli oggetti rilevati
publickey string Nome del file della chiave pubblica.

Property behavior:
- obbligatorio se type è impostato su "SSH agent" e authtype è impostato su "public key"
- sola lettura per gli oggetti rilevati
query_fields array Array di campi di query che verranno inviati durante l'esecuzione di una richiesta HTTP.

Property behavior:
- supportato se type è impostato su "HTTP agent"
- sola lettura per gli oggetti ereditati o rilevati
request_method integer Tipo di metodo della richiesta.

Valori possibili:
0 - (predefinito) GET;
1 - POST;
2 - PUT;
3 - HEAD.

Property behavior:
- supportato se type è impostato su "HTTP agent"
- sola lettura per gli oggetti ereditati o rilevati
retrieve_mode integer Parte della risposta che 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.

Property behavior:
- supportato se type è impostato su "HTTP agent"
- sola lettura per gli oggetti ereditati o rilevati
snmp_oid string OID SNMP.

Property behavior:
- obbligatorio se type è impostato su "SNMP agent"
- sola lettura per gli oggetti ereditati o rilevati
ssl_cert_file string Percorso del file della chiave SSL pubblica.

Property behavior:
- supportato se type è impostato su "HTTP agent"
- sola lettura per gli oggetti ereditati o rilevati
ssl_key_file string Percorso del file della chiave SSL privata.

Property behavior:
- supportato se type è impostato su "HTTP agent"
- sola lettura per gli oggetti ereditati o rilevati
ssl_key_password string Password per il file della chiave SSL.

Property behavior:
- supportato se type è impostato su "HTTP agent"
- sola lettura per gli oggetti ereditati o rilevati
state integer Stato dell'item.

Valori possibili:
0 - (predefinito) normale;
1 - non supportato.

Property behavior:
- sola lettura
status integer Stato dell'item.

Valori possibili:
0 - (predefinito) item abilitato;
1 - item disabilitato.
status_codes string Intervalli dei codici di stato HTTP richiesti, separati da virgole.
Supporta anche le macro utente come parte di un elenco separato da virgole.

Esempio: 200,200-{$M},{$M},200-400

Property behavior:
- supportato se type è impostato su "HTTP agent"
- sola lettura per gli oggetti ereditati o rilevati
templateid ID ID dell'item template padre.

Suggerimento: usare la proprietà hostid per specificare il template a cui appartiene l'item.

Property behavior:
- sola lettura
timeout string Timeout della richiesta di polling dei dati dell'item.
Accetta secondi o unità di tempo con suffisso (ad esempio, 30s, 1m). Accetta anche macro utente.

Intervallo di valori possibile: 1-600s.

Predefinito: "" - usa le impostazioni di proxy/globali.

Property behavior:
- supportato 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 e rilevati
trapper_hosts string Host consentiti.

Property behavior:
- sola lettura per gli oggetti rilevati
- supportato se type è impostato su "Zabbix trapper", oppure se type è impostato su "HTTP agent" e allow_traps è impostato su "Consentire l'accettazione di dati in ingresso".
Se la proprietà viene omessa, viene impostata automaticamente alla macro utente {$TRAPPER.ALLOWED_HOSTS} (valore predefinito). Per impostazione predefinita, {$TRAPPER.ALLOWED_HOSTS} è 127.0.0.1,::1.
Se la proprietà è impostata su una stringa vuota, le connessioni in ingresso saranno negate da tutti gli host.
trends string Unità di tempo per la durata di conservazione dei dati di trend.
Accetta anche macro utente.

Predefinito: 365d.

Property behavior:
- supportato se value_type è impostato su "numeric float" o "numeric unsigned"
- sola lettura per gli oggetti rilevati
units string Unità del valore.

Property behavior:
- supportato se value_type è impostato su "numeric float" o "numeric unsigned"
- sola lettura per gli oggetti ereditati o rilevati
username string Nome utente per l'autenticazione.

Property behavior:
- obbligatorio se type è impostato su "SSH agent", "TELNET agent", oppure se type è impostato su "JMX agent" e password è impostato
- supportato se type è impostato su "Simple check", "Database monitor" o "HTTP agent"
- sola lettura per gli oggetti ereditati (se type è impostato su "HTTP agent") o rilevati
uuid string Identificatore univoco universale, usato per collegare l'item importato a quelli già esistenti. Generato automaticamente se non specificato.

Property behavior:
- supportato se l'item appartiene a un template
valuemapid ID ID della value map associata.

Property behavior:
- supportato se value_type è impostato su "numeric float", "character" o "numeric unsigned"
- sola lettura per gli oggetti ereditati o rilevati
verify_host integer Indica se validare che il nome host della connessione corrisponda a quello nel certificato dell'host.

Valori possibili:
0 - (predefinito) Non validare;
1 - Validare.

Property behavior:
- supportato se type è impostato su "HTTP agent"
- sola lettura per gli oggetti ereditati o rilevati
verify_peer integer Indica se validare che il certificato dell'host sia autentico.

Valori possibili:
0 - (predefinito) Non validare;
1 - Validare.

Property behavior:
- supportato se type è impostato su "HTTP agent"
- sola lettura per gli oggetti ereditati o rilevati

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 della query HTTP

L'oggetto del campo della 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 dell'item

L'oggetto tag dell'item ha le seguenti proprietà.

Proprietà Type Descrizione
tag string Nome del tag dell'item.

Comportamento della proprietà:
- obbligatoria
value string Valore del tag dell'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.

Preelaborazione degli item

L'oggetto di preelaborazione degli item ha le seguenti proprietà.

Proprietà Type Descrizione
type integer Il tipo di opzione di preelaborazione.

Valori possibili:
1 - Moltiplicatore personalizzato;
2 - Rimozione a destra;
3 - Rimozione a sinistra;
4 - Rimozione;
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 - Verifica errore in JSON;
17 - Verifica errore in XML;
18 - Verifica errore tramite 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 - Verifica non supportato;
27 - XML in JSON;
28 - Valore SNMP walk;
29 - SNMP walk in JSON;
30 - Valore SNMP get.

Comportamento della proprietà:
- required
params string Parametri aggiuntivi utilizzati dall'opzione di preelaborazione.
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 - verifica se il messaggio di errore corrisponde a pattern;
\ 1 - verifica se il messaggio di errore non corrisponde a pattern.

Comportamento della proprietà:
- 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 utilizzato in caso di errore del passaggio di preelaborazione.

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.

Comportamento della proprietà:
- 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 degli errori.

Comportamento della proprietà:
- required se error_handler è impostato su "Set custom value" o "Set custom error message"

I seguenti parametri e gestori degli errori sono supportati per ciascun tipo di preelaborazione.

Tipo di preelaborazione Nome Parametro 1 Parametro 2 Parametro 3 Gestori degli errori supportati
1 Moltiplicatore personalizzato numero1, 6 0, 1, 2, 3
2 Rimozione a destra elenco di caratteri2
3 Rimozione a sinistra elenco di caratteri2
4 Rimozione 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 Verifica errore in JSON percorso4 0, 1, 2, 3
17 Verifica errore in XML percorso4 0, 1, 2, 3
18 Verifica errore tramite 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 Verifica 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 in virgola mobile (gli interi vengono convertiti implicitamente in valori float)
2 string
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
7 pattern Prometheus che segue la sintassi: <metric name>{<label name>="<label value>", ...} == <value>. Ciascun componente del pattern Prometheus (metrica, nome etichetta, valore etichetta e valore della metrica) può essere una macro utente.
8 output Prometheus che segue la sintassi: <label name> (può essere una macro utente) 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.