Item-Prototyp-Objekt

Die folgenden Objekte stehen in direktem Zusammenhang mit der itemprototype API.

Item-Prototyp

Das Objekt des Item-Prototyps hat die folgenden Eigenschaften.

Property Type Description
itemid ID ID des Item-Prototyps.

Property behavior:
- schreibgeschützt
- erforderlich für Update-Operationen
delay string Aktualisierungsintervall des Item-Prototyps.

Akzeptiert Sekunden oder Zeiteinheiten mit Suffix (z. B. 30s, 1m, 2h, 1d) und optional einen oder mehrere benutzerdefinierte Intervalle, alle durch Semikolons getrennt. Benutzerdefinierte Intervalle können eine Mischung aus flexiblen und Zeitplan-Intervallen sein.

Akzeptiert Benutzermakros und LLD-Makros. Wenn verwendet, muss der Wert ein einzelnes Makro sein. Mehrere Makros oder Makros in Kombination mit Text werden nicht unterstützt. Flexible Intervalle können als zwei durch einen Schrägstrich getrennte Makros geschrieben werden (z. B. {$FLEX_INTERVAL}/{$FLEX_PERIOD}).

Beispiel:
1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}

Property behavior:
- erforderlich, wenn type auf "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) gesetzt ist oder wenn type auf "Zabbix Agent (active)" (7) gesetzt ist und key_ nicht "mqtt.get" enthält
hostid ID ID des Hosts, zu dem der Item-Prototyp gehört.

Property behavior:
- konstant
- erforderlich für Create-Operationen
interfaceid ID ID der Host-Schnittstelle des Item-Prototyps.

Property behavior:
- erforderlich, wenn der Item-Prototyp zu einem Host gehört und type auf "Zabbix Agent", "IPMI Agent", "JMX Agent", "SNMP trap" oder "SNMP Agent" gesetzt ist
- unterstützt, wenn der Item-Prototyp zu einem Host gehört und type auf "Simple check", "External check", "SSH Agent", "TELNET Agent" oder "HTTP Agent" gesetzt ist
key_ string Schlüssel des Item-Prototyps.

Property behavior:
- erforderlich für Create-Operationen
- schreibgeschützt für geerbte Objekte
name string Name des Item-Prototyps.
Unterstützt Benutzermakros.

Property behavior:
- erforderlich für Create-Operationen
- schreibgeschützt für geerbte Objekte
type integer Typ des Item-Prototyps.

Mögliche Werte:
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:
- erforderlich für Create-Operationen
- schreibgeschützt für geerbte Objekte
url string URL-Zeichenfolge.
Unterstützt LLD-Makros, Benutzermakros, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}.

Property behavior:
- erforderlich, wenn type auf "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
value_type integer Informationstyp des Item-Prototyps.

Mögliche Werte:
0 - numerisch float;
1 - Zeichen;
2 - Log;
3 - numerisch unsigned;
4 - Text;
5 - binär.

Property behavior:
- erforderlich für Create-Operationen
- schreibgeschützt für geerbte Objekte
allow_traps integer Erlaubt das Befüllen des Werts ähnlich wie beim Trapper-Item.

0 - (Standard) Eingehende Daten nicht akzeptieren;
1 - Eingehende Daten akzeptieren.

Property behavior:
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist
authtype integer Authentifizierungsmethode.

Mögliche Werte, wenn type auf "SSH Agent" gesetzt ist:
0 - (Standard) Passwort;
1 - öffentlicher Schlüssel.

Mögliche Werte, wenn type auf "HTTP Agent" gesetzt ist:
0 - (Standard) keine;
1 - basic;
2 - NTLM;
3 - Kerberos;
4 - Digest.

Property behavior:
- unterstützt, wenn type auf "SSH Agent" oder "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte (wenn type auf "HTTP Agent" gesetzt ist)
description string Beschreibung des Item-Prototyps.
follow_redirects integer Antwort-Weiterleitungen beim Abrufen von Daten folgen.

Mögliche Werte:
0 - Weiterleitungen nicht folgen;
1 - (Standard) Weiterleitungen folgen.

Property behavior:
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
headers array Array von Headern, die beim Ausführen einer HTTP-Anfrage gesendet werden.

Property behavior:
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
history string Zeiteinheit, wie lange die Verlaufsdaten gespeichert werden sollen.
Akzeptiert auch Benutzermakros und LLD-Makros.

Standard: 31d.
http_proxy string HTTP(S)-Proxy-Verbindungszeichenfolge.

Property behavior:
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
ipmi_sensor string IPMI-Sensor.

Property behavior:
- erforderlich, wenn type auf "IPMI Agent" gesetzt ist und key_ nicht auf "ipmi.get" gesetzt ist
- unterstützt, wenn type auf "IPMI Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
jmx_endpoint string Benutzerdefinierte Verbindungszeichenfolge des JMX Agent.

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

Property behavior:
- unterstützt, wenn type auf "JMX Agent" gesetzt ist
logtimefmt string Format der Zeit in Logeinträgen.

Property behavior:
- unterstützt, wenn value_type auf "log" gesetzt ist
- schreibgeschützt für geerbte Objekte
master_itemid ID ID des Master-Items.
Rekursion bis zu 3 abhängige Items und Item-Prototypen sowie eine maximale Anzahl abhängiger Items und Item-Prototypen von 29999 sind zulässig.

Property behavior:
- erforderlich, wenn type auf "Dependent item" gesetzt ist
- schreibgeschützt für geerbte Objekte
output_format integer Soll die Antwort in JSON konvertiert werden.

Mögliche Werte:
0 - (Standard) Rohdaten speichern;
1 - In JSON konvertieren.

Property behavior:
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
params string Zusätzliche Parameter abhängig vom Typ des Item-Prototyps:
- ausgeführtes Skript für Item-Prototypen vom Typ SSH Agent und TELNET Agent;
- SQL-Abfrage für Item-Prototypen vom Typ Database monitor;
- Formel für Item-Prototypen vom Typ Calculated;
- das Skript für Item-Prototypen vom Typ Script und Browser.

Property behavior:
- erforderlich, wenn type auf "Database monitor", "SSH Agent", "TELNET Agent", "Calculated", "Script" oder "Browser" gesetzt ist
- schreibgeschützt für geerbte Objekte (wenn type auf "Script" oder "Browser" gesetzt ist)
parameters object/array Zusätzliche Parameter, wenn type auf "Script" oder "Browser" gesetzt ist. Array von Objekten mit den Eigenschaften name und value, wobei name eindeutig sein muss.

Property behavior:
- unterstützt, wenn type auf "Script" oder "Browser" gesetzt ist
- schreibgeschützt für geerbte Objekte
password string Passwort für die Authentifizierung.

Property behavior:
- erforderlich, wenn type auf "JMX Agent" gesetzt ist und username gesetzt ist
- unterstützt, wenn type auf "Simple check", "SSH Agent", "TELNET Agent", "Database monitor" oder "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte (wenn type auf "HTTP Agent" gesetzt ist)
post_type integer Typ des im Attribut posts gespeicherten HTTP-Request-Body.

Mögliche Werte:
0 - (Standard) Rohdaten.
2 - JSON-Daten.
3 - XML-Daten.

Property behavior:
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
posts string Daten des HTTP(S)-Request-Bodys.

Property behavior:
- erforderlich, wenn type auf "HTTP Agent" gesetzt ist und post_type auf "JSON data" oder "XML data" gesetzt ist
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist und post_type auf "Raw data" gesetzt ist
- schreibgeschützt für geerbte Objekte
privatekey string Name der Datei mit dem privaten Schlüssel.

Property behavior:
- erforderlich, wenn type auf "SSH Agent" gesetzt ist und authtype auf "public key" gesetzt ist
publickey string Name der Datei mit dem öffentlichen Schlüssel.

Property behavior:
- erforderlich, wenn type auf "SSH Agent" gesetzt ist und authtype auf "public key" gesetzt ist
query_fields array Array von Query-Feldern, die beim Ausführen einer HTTP-Anfrage gesendet werden.

Property behavior:
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
request_method integer Typ der Anfragemethode.

Mögliche Werte:
0 - (Standard) GET;
1 - POST;
2 - PUT;
3 - HEAD.

Property behavior:
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
retrieve_mode integer Welcher Teil der Antwort gespeichert werden soll.

Mögliche Werte, wenn request_method auf "GET", "POST" oder "PUT" gesetzt ist:
0 - (Standard) Body;
1 - Header;
2 - Sowohl Body als auch Header werden gespeichert.

Mögliche Werte, wenn request_method auf "HEAD" gesetzt ist:
1 - Header.

Property behavior:
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
snmp_oid string SNMP-OID.

Property behavior:
- erforderlich, wenn type auf "SNMP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
ssl_cert_file string Pfad zur öffentlichen SSL-Schlüsseldatei.

Property behavior:
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
ssl_key_file string Pfad zur privaten SSL-Schlüsseldatei.

Property behavior:
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
ssl_key_password string Passwort für die SSL-Schlüsseldatei.

Property behavior:
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
status integer Status des Item-Prototyps.

Mögliche Werte:
0 - (Standard) aktivierter Item-Prototyp;
1 - deaktivierter Item-Prototyp;
3 - nicht unterstützter Item-Prototyp.
status_codes string Durch Kommas getrennte Bereiche erforderlicher HTTP-Statuscodes.
Unterstützt auch Benutzermakros oder LLD-Makros als Teil einer durch Kommas getrennten Liste.

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

Property behavior:
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
templateid ID ID des übergeordneten Vorlage-Item-Prototyps.

Property behavior:
- schreibgeschützt
timeout string Timeout für die Abfrage von Item-Daten.
Akzeptiert Sekunden oder Zeiteinheiten mit Suffix (z. B. 30s, 1m). Akzeptiert auch Benutzermakros und LLD-Makros.

Möglicher Wertebereich: 1-600s.

Standard: "" - Proxy-/Globaleinstellungen verwenden.

Property behavior:
- unterstützt, wenn type auf "Zabbix Agent" (0), "Simple check" (3) und key_ nicht mit "vmware." und "icmpping" beginnt, "Zabbix Agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH Agent" (13), "TELNET Agent" (14), "HTTP Agent" (19), "SNMP Agent" (20) und snmp_oid mit "walk[" oder "get[" beginnt, "Script" (21), "Browser" (22) gesetzt ist
- schreibgeschützt für geerbte Objekte
trapper_hosts string Zulässige Hosts.

Property behavior:
- unterstützt, wenn type auf "Zabbix trapper" gesetzt ist oder wenn type auf "HTTP Agent" gesetzt ist und allow_traps auf "Eingehende Daten akzeptieren" gesetzt ist
trends string Zeiteinheit, wie lange die Trenddaten gespeichert werden sollen.
Akzeptiert auch Benutzermakros und LLD-Makros.

Standard: 365d.

Property behavior:
- unterstützt, wenn value_type auf "numeric float" oder "numeric unsigned" gesetzt ist
units string Werteeinheiten.

Property behavior:
- unterstützt, wenn value_type auf "numeric float" oder "numeric unsigned" gesetzt ist
- schreibgeschützt für geerbte Objekte
username string Benutzername für die Authentifizierung.

Property behavior:
- erforderlich, wenn type auf "SSH Agent" oder "TELNET Agent" gesetzt ist oder wenn type auf "JMX Agent" gesetzt ist und password gesetzt ist
- unterstützt, wenn type auf "Simple check", "Database monitor" oder "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte (wenn type auf "HTTP Agent" gesetzt ist)
uuid string Universell eindeutige Kennung, die zum Verknüpfen importierter Item-Prototypen mit bereits vorhandenen verwendet wird. Wird automatisch generiert, wenn nicht angegeben.

Property behavior:
- unterstützt, wenn der Item-Prototyp zu einer Vorlage gehört
valuemapid ID ID der zugehörigen Wertzuordnung.

Property behavior:
- unterstützt, wenn value_type auf "numeric float", "character" oder "numeric unsigned" gesetzt ist
- schreibgeschützt für geerbte Objekte
verify_host integer Ob der Hostname der Verbindung mit dem im Zertifikat des Hosts übereinstimmt, validiert werden soll.

Mögliche Werte:
0 - (Standard) nicht validieren;
1 - validieren.

Property behavior:
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
verify_peer integer Ob geprüft werden soll, dass das Zertifikat des Hosts authentisch ist.

Mögliche Werte:
0 - (Standard) nicht validieren;
1 - validieren.

Property behavior:
- unterstützt, wenn type auf "HTTP Agent" gesetzt ist
- schreibgeschützt für geerbte Objekte
discover integer Erkennungsstatus des Item-Prototyps.

Mögliche Werte:
0 - (Standard) neue Items werden erkannt;
1 - neue Items werden nicht erkannt und vorhandene Items werden als verloren markiert.

HTTP-Header

Das Header-Objekt hat die folgenden Eigenschaften:

Eigenschaft Typ Beschreibung
name string Name des HTTP-Headers.

Eigenschaftsverhalten:
- erforderlich
value string Wert des Headers.

Eigenschaftsverhalten:
- erforderlich

HTTP-Abfragefeld

Das HTTP-Abfragefeldobjekt definiert einen Namen und einen Wert, die zur Angabe eines URL-Parameters verwendet werden. Es hat die folgenden Eigenschaften:

Eigenschaft Typ Beschreibung
name string Name des Parameters.

Eigenschaftsverhalten:
- erforderlich
value string Wert des Parameters.

Eigenschaftsverhalten:
- erforderlich

Datenpunkt-Prototyp-Tag

Das Objekt für den Datenpunkt-Prototyp-Tag hat die folgenden Eigenschaften.

Property Type Description
tag string Name des Datenpunkt-Prototyp-Tags.

Property behavior:
- required
value string Wert des Datenpunkt-Prototyp-Tags.

Item-Prototyp-Vorverarbeitung

Das Objekt der Item-Prototyp-Vorverarbeitung hat die folgenden Eigenschaften.

Property Type Description
type integer Der Typ der Vorverarbeitungsoption.

Mögliche Werte:
1 - Benutzerdefinierter Multiplikator;
2 - Rechts trimmen;
3 - Links trimmen;
4 - Trimmen;
5 - Regulärer Ausdruck;
6 - Boolesch zu Dezimal;
7 - Oktal zu Dezimal;
8 - Hexadezimal zu Dezimal;
9 - Einfache Änderung;
10 - Änderung pro Sekunde;
11 - XML XPath;
12 - JSONPath;
13 - Im Bereich;
14 - Entspricht regulärem Ausdruck;
15 - Entspricht nicht regulärem Ausdruck;
16 - Auf Fehler in JSON prüfen;
17 - Auf Fehler in XML prüfen;
18 - Auf Fehler mithilfe regulären Ausdrucks prüfen;
19 - Unverändert verwerfen;
20 - Unverändert mit Heartbeat verwerfen;
21 - JavaScript;
22 - Prometheus-Muster;
23 - Prometheus zu JSON;
24 - CSV zu JSON;
25 - Ersetzen;
26 - Nicht unterstützt prüfen;
27 - XML zu JSON;
28 - SNMP-Walk-Wert;
29 - SNMP-Walk zu JSON;
30 - SNMP-Get-Wert.

Property behavior:
- required
params string Zusätzliche Parameter, die von der Vorverarbeitungsoption verwendet werden.
Mehrere Parameter werden durch das Zeilenumbruchzeichen (\n) getrennt.

Wenn type auf "Check unsupported" gesetzt ist, folgen die Parameter der Syntax <scope>[\n<pattern>], wobei pattern ein regulärer Ausdruck und scope einer der folgenden Werte ist:
-1 - beliebigen Fehler abgleichen;
\ 0 - prüfen, ob die Fehlermeldung mit pattern übereinstimmt;
\ 1 - prüfen, ob die Fehlermeldung nicht mit pattern übereinstimmt.

Property behavior:
- required wenn type auf "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) oder "SNMP get value" (30) gesetzt ist
error_handler integer Aktionstyp, der im Falle eines Fehlers bei einem Vorverarbeitungsschritt verwendet wird.

Mögliche Werte:
0 - Die Fehlermeldung wird vom Zabbix-Server gesetzt;
1 - Wert verwerfen;
2 - Benutzerdefinierten Wert setzen;
3 - Benutzerdefinierte Fehlermeldung setzen.

Mögliche Werte, wenn type auf "Check unsupported" gesetzt ist:
1 - Wert verwerfen;
2 - Benutzerdefinierten Wert setzen;
3 - Benutzerdefinierte Fehlermeldung setzen.

Property behavior:
- required wenn type auf "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) oder "SNMP get value" (30) gesetzt ist
error_handler_params string Parameter des Fehlerbehandlers.

Property behavior:
- required wenn error_handler auf "Set custom value" oder "Set custom error message" gesetzt ist

Die folgenden Parameter und Fehlerbehandler werden für jeden Vorverarbeitungstyp unterstützt.

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 integer or floating-point number
2 string
3 regular expression
4 JSONPath or XML XPath
5 positive integer (with support of time suffixes, e.g. 30s, 1m, 2h, 1d)
6 user macro, LLD macro
7 Prometheus pattern following the syntax: <metric name>{<label name>="<label value>", ...} == <value>. Each Prometheus pattern component (metric, label name, label value and metric value) can be user macro or LLD macro.
8 Prometheus output following the syntax: <label name> (can be a user macro or an LLD macro) if label is selected as the second parameter.
9 One of the aggregation functions: sum, min, max, avg, count if function is selected as the second parameter.
10 Supports multiple "Field name,OID prefix,Format records" records delimited by a new line character.