You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.

> Item prototype-object

De volgende objecten zijn direct gerelateerd aan de itemprototype API.

Item-prototype

Het object van het item-prototype heeft de volgende eigenschappen.

Eigenschap Type Beschrijving
itemid string ID van het item-prototype.

Eigenschapsgedrag:
- alleen-lezen
- verplicht voor update-operaties
delay string Update-interval van het item-prototype.
Accepteert seconden of een tijdeenheid met achtervoegsel (30s, 1m, 2u, 1d).
Optioneel kunnen één of meer aangepaste intervallen worden gespecificeerd, zowel als flexibele intervallen of geplande intervallen.
Meerdere intervallen worden gescheiden door een puntkomma.
Gebruikermacro's en LLD-macro's kunnen worden gebruikt. Een enkele macro moet het hele veld vullen. Meerdere macro's in een veld of macro's gemengd met tekst worden niet ondersteund.
Flexibele intervallen kunnen worden geschreven als twee macro's gescheiden door een schuine streep (bijv. {$FLEX_INTERVAL}/{$FLEX_PERIOD}).

Eigenschapsgedrag:
- verplicht als type is ingesteld op "Zabbix-agent" (0), "Eenvoudige controle" (3), "Zabbix intern" (5), "Externe controle" (10), "Database-monitor" (11), "IPMI-agent" (12), "SSH-agent" (13), "TELNET-agent" (14), "Berekend" (15), "JMX-agent" (16), "HTTP-agent" (19), "SNMP-agent" (20), "Script" (21), of als type is ingesteld op "Zabbix-agent (actief)" (7) en key_ bevat niet "mqtt.get"
hostid string ID van de host waartoe het item-prototype behoort.

Eigenschapsgedrag:
- constant
- verplicht voor aanmaakoperaties
interfaceid string ID van de hostinterface van het item-prototype.

Eigenschapsgedrag:
- verplicht als het item-prototype behoort tot een host en type is ingesteld op "Zabbix-agent", "IPMI-agent", "JMX-agent", "SNMP-trap" of "SNMP-agent"
- ondersteund als het item-prototype behoort tot een host en type is ingesteld op "Eenvoudige controle", "Externe controle", "SSH-agent", "TELNET-agent" of "HTTP-agent"
key_ string Sleutel van het item-prototype.

Eigenschapsgedrag:
- verplicht voor aanmaakoperaties
- alleen-lezen voor overgeërfde objecten
name string Naam van het item-prototype.

Eigenschapsgedrag:
- verplicht voor aanmaakoperaties
- alleen-lezen voor overgeërfde objecten
type integer Type van het item-prototype.

Mogelijke waarden:
0 - Zabbix-agent;
2 - Zabbix-trapper;
3 - Eenvoudige controle;
5 - Zabbix intern;
7 - Zabbix-agent (actief);
10 - Externe controle;
11 - Database-monitor;
12 - IPMI-agent;
13 - SSH-agent;
14 - TELNET-agent;
15 - Berekend;
16 - JMX-agent;
17 - SNMP-trap;
18 - Afhankelijk item;
19 - HTTP-agent;
20 - SNMP-agent;
21 - Script.

Eigenschapsgedrag:
- verplicht voor aanmaakoperaties
- alleen-lezen voor overgeërfde objecten
url string URL-string.
Ondersteunt LLD-macro's, gebruikersmacro's, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}.

Eigenschapsgedrag:
- verplicht als type is ingesteld op "HTTP-agent"
- alleen-lezen voor overgeërfde objecten
value_type integer Type informatie van het item-prototype.

Mogelijke waarden:
0 - numeriek met decimalen;
1 - tekenreeks;
2 - logboek;
3 - numeriek zonder teken;
4 - tekst.

Eigenschapsgedrag:
- verplicht voor aanmaakoperaties
- alleen-lezen voor overgeërfde objecten
allow_traps integer Toestaan om de waarde op een vergelijkbare manier in te vullen als het trapper-item.

0 - (standaard) Sta niet toe om inkomende gegevens te accepteren;
1 - Sta toe om inkomende gegevens te accepteren.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent"
authtype integer Authenticatiemethode.

Mogelijke waarden als type is ingesteld op "SSH-agent":
0 - (standaard) wachtwoord;
1 - openbare sleutel.

Mogelijke waarden als type is ingesteld op "HTTP-agent":
0 - (standaard) geen;
1 - basis;
2 - NTLM;
3 - Kerberos.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "SSH-agent" of "HTTP-agent"
- alleen-lezen voor overgeërfde objecten (als type is ingesteld op "HTTP-agent")
description string Beschrijving van het item-prototype.
follow_redirects integer Volg omleidingen van antwoorden tijdens het verzamelen van gegevens.

Mogelijke waarden:
0 - Volg geen omleidingen;
1 - (standaard) Volg omleidingen.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent"
- alleen-lezen voor overgeërfde objecten
headers object Object met HTTP(S)-verzoekheaders, waarbij de naam van de header wordt gebruikt als sleutel en de waarde van de header als waarde.

Voorbeeld: { "User-Agent": "Zabbix" }

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent"
- alleen-lezen voor overgeërfde objecten
history string Een tijdeenheid van hoelang de geschiedenisgegevens moeten worden bewaard.
Accepteert ook gebruikersmacro's en LLD-macro's.

Standaard: 90d.
http_proxy string HTTP(S)-proxyverbindingsreeks.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent"
- alleen-lezen voor overgeërfde objecten
ipmi_sensor string IPMI-sensor.

Eigenschapsgedrag:
- vereist als type is ingesteld op "IPMI-agent" en key_ is niet ingesteld op "ipmi.get"
- ondersteund als type is ingesteld op "IPMI-agent"
- alleen-lezen voor overgeërfde objecten
jmx_endpoint string Aangepaste verbindingsreeks voor JMX-agent.

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

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "JMX-agent"
logtimefmt string Indeling van de tijd in logboekvermeldingen.

Eigenschapsgedrag:
- ondersteund als value_type is ingesteld op "log"
- alleen-lezen voor overgeërfde objecten
master_itemid integer ID van het hoofditem.
Recursie tot 3 afhankelijke items en item-prototypen en een maximum aantal afhankelijke items en item-prototypen van 29999 zijn toegestaan.

Eigenschapsgedrag:
- vereist als type is ingesteld op "Afhankelijk item"
- alleen-lezen voor overgeërfde objecten
output_format integer Moet de reactie worden geconverteerd naar JSON.

Mogelijke waarden:
0 - (standaard) Sla rauw op;
1 - Converteer naar JSON.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent"
- alleen-lezen voor overgeërfde objecten
params string Aanvullende parameters afhankelijk van het type van het item-prototype:
- uitgevoerd script voor SSH-agent en TELNET-agent item-prototypen;
- SQL-query voor database-monitor item-prototypen;
- formule voor berekende item-prototypen.

Eigenschapsgedrag:
- vereist als type is ingesteld op "Database-monitor", "SSH-agent", "TELNET-agent", "Berekend" of "Script"
- alleen-lezen voor overgeërfde objecten (als type is ingesteld op "Script")
parameters array Aanvullende parameters als type is ingesteld op "Script". Array van objecten met eigenschappen name en value, waarbij name uniek moet zijn.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "Script"
- alleen-lezen voor overgeërfde objecten
password string Wachtwoord voor authenticatie.

Eigenschapsgedrag:
- vereist als type is ingesteld op "JMX-agent" en username is ingesteld
- ondersteund als type is ingesteld op "Eenvoudige controle", "SSH-agent", "TELNET-agent", "Database-monitor" of "HTTP-agent"
- alleen-lezen voor overgeërfde objecten (als type is ingesteld op "HTTP-agent")
post_type integer Type van post-gegevens die zijn opgeslagen in de eigenschap posts.

Mogelijke waarden:
0 - (standaard) Rauwe gegevens.
2 - JSON-gegevens.
3 - XML-gegevens.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent"
- alleen-lezen voor overgeërfde objecten
posts string HTTP(S)-verzoekbodygegevens.

Eigenschapsgedrag:
- vereist als type is ingesteld op "HTTP-agent" en post_type is ingesteld op "JSON-gegevens" of "XML-gegevens"
- ondersteund als type is ingesteld op "HTTP-agent" en post_type is ingesteld op "Rauwe gegevens"
- alleen-lezen voor overgeërfde objecten
privatekey string Naam van het bestand met de privésleutel.

Eigenschapsgedrag:
- vereist als type is ingesteld op "SSH-agent" en authtype is ingesteld op "openbare sleutel"
publickey string Naam van het bestand met de openbare sleutel.

Eigenschapsgedrag:
- vereist als type is ingesteld op "SSH-agent" en authtype is ingesteld op "openbare sleutel"
query_fields array Queryparameters. Array van objecten met paren key:value, waarbij value een lege tekenreeks kan zijn.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent"
- alleen-lezen voor overgeërfde objecten
request_method integer Type verzoekmethode.

Mogelijke waarden:
0 - (standaard) GET;
1 - POST;
2 - PUT;
3 - HEAD.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent"
- alleen-lezen voor overgeërfde objecten
retrieve_mode integer Welk deel van het antwoord moet worden opgeslagen.

Mogelijke waarden als request_method is ingesteld op "GET", "POST" of "PUT":
0 - (standaard) Body;
1 - Headers;
2 - Zowel body als headers worden opgeslagen.

Mogelijke waarden als request_method is ingesteld op "HEAD":
1 - Headers.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent"
- alleen-lezen voor overgeërfde objecten
snmp_oid string SNMP OID.

Eigenschapsgedrag:
- vereist als type is ingesteld op "SNMP-agent"
- alleen-lezen voor overgeërfde objecten
ssl_cert_file string Pad naar het bestand met het openbare SSL-certificaat.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent"
- alleen-lezen voor overgeërfde objecten
ssl_key_file string Pad naar het bestand met het privé SSL-certificaat.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent"
- alleen-lezen voor overgeërfde objecten
ssl_key_password string Wachtwoord voor het SSL-certificaat.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent"
- alleen-lezen voor overgeërfde objecten
status integer Status van het item-prototype.

Mogelijke waarden:
0 - (standaard) ingeschakeld item-prototype;
1 - uitgeschakeld item-prototype;
3 - niet-ondersteund item-prototype.
status_codes string Bereiken van vereiste HTTP-statuscodes, gescheiden door komma's.
Ondersteunt ook gebruikersmacro's of LLD-macro's als onderdeel van een komma-gescheiden lijst.

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

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent"
- alleen-lezen voor overgeërfde objecten
templateid string ID van het bovenliggende sjabloon-item-prototype.

Eigenschapsgedrag:
- alleen-lezen
timeout string Time-out voor het aanvragen van itemgegevens bij gegevensverzameling.
Ondersteunt gebruikersmacro's en LLD-macro's.

Standaard: 3s.
Maximale waarde: 60s.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent" of "Script"
- alleen-lezen voor overgeërfde objecten
trapper_hosts string Toegestane hosts.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "Zabbix-trapper", of als type is ingesteld op "HTTP-agent" en allow_traps is ingesteld op "Inkomende gegevens accepteren"
trends string Een tijdeenheid van hoelang de trendgegevens moeten worden bewaard.
Accepteert ook gebruikersmacro's en LLD-macro's.

Standaard: 365d.

Eigenschapsgedrag:
- ondersteund als value_type is ingesteld op "numeriek zwevend" of "numeriek niet-ondertekend"
units string Eenheid van de waarde.

Eigenschapsgedrag:
- ondersteund als value_type is ingesteld op "numeriek zwevend" of "numeriek niet-ondertekend"
- alleen-lezen voor overgeërfde objecten
username string Gebruikersnaam voor authenticatie.

Eigenschapsgedrag:
- vereist als type is ingesteld op "SSH-agent" of "TELNET-agent", of als type is ingesteld op "JMX-agent" en password is ingesteld
- ondersteund als type is ingesteld op "Eenvoudige controle", "Database-monitor" of "HTTP-agent"
- alleen-lezen voor overgeërfde objecten (als type is ingesteld op "HTTP-agent")
uuid string Unieke universele identifier, gebruikt om geïmporteerde item-prototypen te koppelen aan reeds bestaande. Wordt automatisch gegenereerd indien niet opgegeven.

Eigenschapsgedrag:
- ondersteund als het item-prototype toebehoort aan een sjabloon
valuemapid string ID van de bijbehorende waardeafbeelding.

Eigenschapsgedrag:
- ondersteund als value_type is ingesteld op "numeriek zwevend", "karakter" of "numeriek niet-ondertekend"
- alleen-lezen voor overgeërfde objecten
verify_host integer Valideer of de hostnaam in de URL in het Common Name-veld of een Subject Alternate Name-veld van het hostcertificaat staat.

Mogelijke waarden:
0 - (standaard) Niet valideren;
1 - Valideren.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent"
- alleen-lezen voor overgeërfde objecten
verify_peer integer Valideer of het hostcertificaat authentiek is.

Mogelijke waarden:
0 - (standaard) Niet valideren;
1 - Valideren.

Eigenschapsgedrag:
- ondersteund als type is ingesteld op "HTTP-agent"
- alleen-lezen voor overgeërfde objecten
discover integer Status van item-prototype-ontdekking.

Mogelijke waarden:
0 - (standaard) nieuwe items zullen worden ontdekt;
1 - nieuwe items zullen niet worden ontdekt en bestaande items zullen worden gemarkeerd als verloren.

HTTP header

The header object has the following properties:

Property Type Description
name
(required)
string HTTP header name.
value
(required)
string Header value.

HTTP query field

The query field object defines a name and value that is used to specify a URL parameter. It has the following properties:

Property Type Description
name
(required)
string Name of the parameter.
value
(required)
string Parameter value.

Item prototype tag

Het object "item prototype tag" heeft de volgende eigenschappen.

Eigenschap Type Beschrijving
tag string Naam van de tag van het item prototype.

Eigenschapsgedrag:
- vereist
value string Waarde van de tag van het item prototype.

Item prototype voorbewerking

Het object "item prototype voorbewerking" heeft de volgende eigenschappen.

Eigenschap Type Beschrijving
type integer Het type voorbewerkingsmogelijkheid.

Mogelijke waarden:
1 - Aangepaste vermenigvuldiger;
2 - Rechts trimmen;
3 - Links trimmen;
4 - Trimmen;
5 - Overeenkomst met reguliere expressie;
6 - Booleaan naar decimaal;
7 - Octaal naar decimaal;
8 - Hexadecimaal naar decimaal;
9 - Eenvoudige wijziging;
10 - Wijziging per seconde;
11 - XML XPath;
12 - JSONPath;
13 - In bereik;
14 - Komt overeen met reguliere expressie;
15 - Komt niet overeen met reguliere expressie;
16 - Controleer op fout in JSON;
17 - Controleer op fout in XML;
18 - Controleer op fout met behulp van reguliere expressie;
19 - Onveranderd verwerpen;
20 - Onveranderd verwerpen met hartslag;
21 - JavaScript;
22 - Prometheus-patroon;
23 - Prometheus naar JSON;
24 - CSV naar JSON;
25 - Vervangen;
26 - Controle ongeschikt;
27 - XML naar JSON;
28 - SNMP-wandelwaarde;
29 - SNMP-wandel naar JSON.

Eigenschapsgedrag:
- vereist
params string Aanvullende parameters gebruikt door de voorbewerkingsmogelijkheid.
Meerdere parameters worden gescheiden door het newline (\n) teken.

Eigenschapsgedrag:
- vereist als het type is ingesteld op "Aangepaste vermenigvuldiger" (1), "Rechts trimmen" (2), "Links trimmen" (3), "Trimmen" (4), "Overeenkomst met reguliere expressie" (5), "XML XPath" (11), "JSONPath" (12), "In bereik" (13), "Komt overeen met reguliere expressie" (14), "Komt niet overeen met reguliere expressie" (15), "Controleer op fout in JSON" (16), "Controleer op fout in XML" (17), "Controleer op fout met behulp van reguliere expressie" (18), "Onveranderd verwerpen met hartslag" (20), "JavaScript" (21), "Prometheus-patroon" (22), "Prometheus naar JSON" (23), "CSV naar JSON" (24), "Controle ongeschikt" (26), "XML naar JSON" (27), "SNMP-wandelwaarde" (28) of "SNMP-wandel naar JSON" (29)
error_handler integer Actietype dat wordt gebruikt bij falen van de voorbewerkingsstap.

Mogelijke waarden:
0 - Foutbericht wordt ingesteld door de Zabbix-server;
1 - Waarde verwerpen;
2 - Aangepaste waarde instellen;
3 - Aangepast foutbericht instellen.

Mogelijke waarden als type is ingesteld op "Controle ongeschikt":
1 - Waarde verwerpen;
2 - Aangepaste waarde instellen;
3 - Aangepast foutbericht instellen.

Eigenschapsgedrag:
- vereist als type is ingesteld op "Aangepaste vermenigvuldiger" (1), "Overeenkomst met reguliere expressie" (5), "Booleaan naar decimaal" (6), "Octaal naar decimaal" (7), "Hexadecimaal naar decimaal" (8), "Eenvoudige wijziging" (9), "Wijziging per seconde" (10), "XML XPath" (11), "JSONPath" (12), "In bereik" (13), "Komt overeen met reguliere expressie" (14), "Komt niet overeen met reguliere expressie" (15), "Controleer op fout in JSON" (16), "Controleer op fout in XML" (17), "Controleer op fout met behulp van reguliere expressie" (18), "Prometheus-patroon" (22), "Prometheus naar JSON" (23), "CSV naar JSON" (24), "Controle ongeschikt" (26), "XML naar JSON" (27), "SNMP-wandelwaarde" (28) of "SNMP-wandel naar JSON" (29)
error_handler_params string Parameters voor foutafhandeling.

Eigenschapsgedrag:
- vereist als error_handler is ingesteld op "Aangepaste waarde instellen" of "Aangepast foutbericht instellen"

De volgende parameters en foutafhandelingsmogelijkheden worden ondersteund voor elk voorbewerkings type.

Voorbewerkings type Naam Parameter 1 Parameter 2 Parameter 3 Ondersteunde foutafhandelingsmogelijkheden
1 Aangepaste vermenigvuldiger nummer1, 6^ 0, 1, 2, 3
2 Rechts trimmen lijst met tekens2
3 Links trimmen lijst met tekens2
4 Trimmen lijst met tekens2
5 Overeenkomst met reguliere expressie patroon3 uitvoer2 0, 1, 2, 3
6 Booleaan naar decimaal 0, 1, 2, 3
7 Octaal naar decimaal 0, 1, 2, 3
8 Hexadecimaal naar decimaal 0, 1, 2, 3
9 Eenvoudige wijziging 0, 1, 2, 3
10 Wijziging per seconde 0, 1, 2, 3
11 XML XPath pad4 0, 1, 2, 3
12 JSONPath pad4 0, 1, 2, 3
13 In bereik min1, 6^ max1, 6^ 0, 1, 2, 3
14 Komt overeen met reguliere expressie patroon3 0, 1, 2, 3
15 Komt niet overeen met reguliere expressie patroon3 0, 1, 2, 3
16 Controleer op fout in JSON pad4 0, 1, 2, 3
17 Controleer op fout in XML pad4 0, 1, 2, 3
18 Controleer op fout met behulp van reguliere expressie patroon3 uitvoer2 0, 1, 2, 3
19 Onveranderd verwerpen
20 Onveranderd verwerpen met hartslag seconden5, 6^
21 JavaScript script2
22 Prometheus-patroon patroon6, 7^ waarde, label, functie uitvoer8, 9^ 0, 1, 2, 3
23 Prometheus naar JSON patroon6, 7^ 0, 1, 2, 3
24 CSV naar JSON teken2 teken2 0,1 0, 1, 2, 3
25 Vervangen zoekreeks2 vervanging2
26 Controle ongeschikt 1, 2, 3
27 XML naar JSON 0, 1, 2, 3
28 SNMP-wandelwaarde OID2 Formaat:
0 - Ongewijzigd
1 - UTF-8 uit Hex-STRING
2 - MAC uit Hex-STRING
3 - Integer uit BITS
0, 1, 2, 3
29 SNMP-wandel naar JSON10 Veldnaam2 OID-voorvoegsel2 Formaat:
0 - Ongewijzigd
1 - UTF-8 uit Hex-STRING
2 - MAC uit Hex-STRING
3 - Integer uit BITS
0, 1, 2, 3

1 geheel getal of drijvendekommagetallen
2 tekenreeks
3 reguliere expressie
4 JSONPath of XML XPath
5 positief geheel getal (met ondersteuning van tijdsuffixen, bijv. 30s, 1m, 2u, 1d)
6 gebruikersmacro, LLD-macro
7 Prometheus-patroon volgens de syntaxis: <metrieknaam>{<labelnaam>="<labelwaarde>", ...} == <waarde>. Elke component van het Prometheus-patroon (metriek, labelnaam, labelwaarde en metriek waarde) kan een gebruikersmacro of een LLD-macro zijn.
8 Prometheus-uitvoer volgens de syntaxis: <labelnaam> (kan een gebruikersmacro of een LLD-macro zijn) als label is geselecteerd als tweede parameter.
9 Een van de aggregatiefuncties: sum, min, max, avg, count als functie is geselecteerd als tweede parameter.
10 Ondersteunt meerdere records "Veldnaam,OID-voorvoegsel,Formaat" die gescheiden zijn door een nieuw regelteken.