Item-Prototyp-Objekt
Die folgenden Objekte stehen in direktem Zusammenhang mit der itemprototype API.
Datenpunkt-Prototyp
Das Datenpunkt-Prototypobjekt verfügt über die folgenden Eigenschaften.
| Property | Type | Beschreibung |
|---|---|---|
| itemid | ID | ID des Datenpunkt-Prototyps. Verhalten der Eigenschaft: - schreibgeschützt - erforderlich für Aktualisierungsvorgänge |
| delay | string | Aktualisierungsintervall des Datenpunkt-Prototyps. Akzeptiert eine Anzahl von Sekunden (z. B. 1, 60, 300), einen Wert mit einem Zeit-Suffix (z. B. 30s, 1m, 2h, 1d) oder optional ein oder mehrere benutzerdefinierte Intervalle, die durch Semikolons getrennt sind. Benutzerdefinierte Intervalle können eine Mischung aus flexiblen Intervallen und Zeitplanintervallen sein.Akzeptiert Benutzermakros und LLD-Makros. Bei Verwendung muss der Wert aus einem einzelnen Makro bestehen. 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}Verhalten der Eigenschaft: - 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), „Telemetry query“ (24) 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 Datenpunkt-Prototyp gehört. Verhalten der Eigenschaft: - konstant - erforderlich für Erstellungsvorgänge |
| interfaceid | ID | ID der Host-Schnittstelle des Datenpunkt-Prototyps. Verhalten der Eigenschaft: - erforderlich, wenn der Datenpunkt-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 Datenpunkt-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 Datenpunkt-Prototyps. Verhalten der Eigenschaft: - erforderlich für Erstellungsvorgänge - schreibgeschützt für geerbte Objekte |
| name | string | Name des Datenpunkt-Prototyps. Unterstützt Benutzermakros. Verhalten der Eigenschaft: - erforderlich für Erstellungsvorgänge - schreibgeschützt für geerbte Objekte |
| type | integer | Typ des Datenpunkt-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; 24 - Telemetry query. Verhalten der Eigenschaft: - erforderlich für Erstellungsvorgänge - 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}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}. Verhalten der Eigenschaft: - erforderlich, wenn type auf „HTTP agent“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| value_type | integer | Informationstyp des Datenpunkt-Prototyps. Mögliche Werte: 0 - numerischer Gleitkommawert; 1 - Zeichen; 2 - Protokoll; 3 - numerischer Ganzzahlwert ohne Vorzeichen; 4 - Text; 5 - Binärdaten; 6 - JSON. Verhalten der Eigenschaft: - erforderlich für Erstellungsvorgänge - schreibgeschützt für geerbte Objekte |
| allow_traps | integer | Ermöglicht das Befüllen des Werts ähnlich wie bei einem Trapper-Datenpunkt. 0 - (Standard) Keine eingehenden Daten akzeptieren; 1 - Eingehende Daten akzeptieren. Verhalten der Eigenschaft: - 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. Verhalten der Eigenschaft: - 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 Datenpunkt-Prototyps. |
| flags | integer | Herkunft des Datenpunkt-Prototyps. Mögliche Werte: 2 - ein Datenpunkt-Prototyp; 6 - ein ermittelter Datenpunkt-Prototyp Verhalten der Eigenschaft: - schreibgeschützt |
| follow_redirects | integer | Weiterleitungen der Antwort beim Abrufen von Daten verfolgen. Mögliche Werte: 0 - Weiterleitungen nicht verfolgen; 1 - (Standard) Weiterleitungen verfolgen. Verhalten der Eigenschaft: - unterstützt, wenn type auf „HTTP agent“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| headers | array | Array von Headern, die bei einer HTTP-Anfrage gesendet werden. Verhalten der Eigenschaft: - unterstützt, wenn type auf „HTTP agent“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| history | string | Zeiteinheit für die Dauer der Speicherung von Verlaufsdaten. Akzeptiert außerdem ein Benutzermakro und ein LLD-Makro. Standard: 31d. |
| http_proxy | string | HTTP(S)-Proxy-Verbindungszeichenfolge. Verhalten der Eigenschaft: - unterstützt, wenn type auf „HTTP agent“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| ipmi_sensor | string | IPMI-Sensor. Verhalten der Eigenschaft: - erforderlich, wenn type auf „IPMI agent“ gesetzt 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 Verhalten der Eigenschaft: - unterstützt, wenn type auf „JMX agent“ gesetzt ist |
| logtimefmt | string | Zeitformat in Protokolleinträgen. Verhalten der Eigenschaft: - unterstützt, wenn value_type auf „log“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| master_itemid | ID | ID des Master-Datenpunkts. Verhalten der Eigenschaft: - erforderlich, wenn type auf „Dependent item“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| output_format | integer | Gibt an, ob die Antwort in JSON konvertiert werden soll. Mögliche Werte: 0 - (Standard) Rohdaten speichern; 1 - In JSON konvertieren. Verhalten der Eigenschaft: - 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 Datenpunkt-Prototyps: - ausgeführtes Skript für Datenpunkt-Prototypen vom Typ SSH agent und TELNET agent; - SQL-Abfrage für Datenpunkt-Prototypen vom Typ Database monitor; - Formel für Datenpunkt-Prototypen vom Typ Calculated; - Skript für Datenpunkt-Prototypen vom Typ Script und Browser. Verhalten der Eigenschaft: - 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.Verhalten der Eigenschaft: - unterstützt, wenn type auf „Script“ oder „Browser“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| password | string | Passwort für die Authentifizierung. Verhalten der Eigenschaft: - erforderlich, wenn type auf „JMX agent“ gesetzt und username angegeben 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 Feld posts gespeicherten Textkörpers.Mögliche Werte: 0 - (Standard) Rohdaten. 2 - JSON-Daten. 3 - XML-Daten. Verhalten der Eigenschaft: - unterstützt, wenn type auf „HTTP agent“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| posts | string | Textkörper der HTTP(S)-Anfrage. Verhalten der Eigenschaft: - erforderlich, wenn type auf „HTTP agent“ und post_type auf „JSON data“ oder „XML data“ gesetzt ist- unterstützt, wenn type auf „HTTP agent“ und post_type auf „Raw data“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| privatekey | string | Name der Datei mit dem privaten Schlüssel. Verhalten der Eigenschaft: - erforderlich, wenn type auf „SSH agent“ und authtype auf „public key“ gesetzt ist |
| publickey | string | Name der Datei mit dem öffentlichen Schlüssel. Verhalten der Eigenschaft: - erforderlich, wenn type auf „SSH agent“ und authtype auf „public key“ gesetzt ist |
| query_fields | array | Array von Abfragefeldern, die bei einer HTTP-Anfrage gesendet werden. Verhalten der Eigenschaft: - 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. Verhalten der Eigenschaft: - unterstützt, wenn type auf „HTTP agent“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| retrieve_mode | integer | Gibt an, welcher Teil der Antwort gespeichert werden soll. Mögliche Werte, wenn request_method auf „GET“, „POST“ oder „PUT“ gesetzt ist:0 - (Standard) Textkörper; 1 - Header; 2 - Textkörper und Header werden gespeichert. Mögliche Werte, wenn request_method auf „HEAD“ gesetzt ist:1 - Header. Verhalten der Eigenschaft: - unterstützt, wenn type auf „HTTP agent“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| snmp_oid | string | SNMP-OID. Verhalten der Eigenschaft: - erforderlich, wenn type auf „SNMP agent“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| ssl_cert_file | string | Dateipfad des öffentlichen SSL-Schlüssels. Verhalten der Eigenschaft: - unterstützt, wenn type auf „HTTP agent“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| ssl_key_file | string | Dateipfad des privaten SSL-Schlüssels. Verhalten der Eigenschaft: - 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. Verhalten der Eigenschaft: - unterstützt, wenn type auf „HTTP agent“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| status | integer | Status des Datenpunkt-Prototyps. Mögliche Werte: 0 - (Standard) aktivierter Datenpunkt-Prototyp; 1 - deaktivierter Datenpunkt-Prototyp; 3 - nicht unterstützter Datenpunkt-Prototyp. |
| status_codes | string | Durch Kommas getrennte Bereiche erforderlicher HTTP-Statuscodes. Unterstützt außerdem Benutzermakros oder LLD-Makros als Teil einer durch Kommas getrennten Liste. Beispiel: 200,200-{$M},{$M},200-400 Verhalten der Eigenschaft: - unterstützt, wenn type auf „HTTP agent“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| templateid | ID | ID des Datenpunkt-Prototyps der übergeordneten Vorlage. Verhalten der Eigenschaft: - schreibgeschützt |
| timeout | string | Zeitüberschreitung für die Abfrage von Datenpunkten. Akzeptiert eine Anzahl von Sekunden (z. B. 1, 60, 300) oder einen Wert mit einem Zeit-Suffix (z. B. 30s, 1m). Akzeptiert außerdem Benutzermakros und LLD-Makros.Möglicher Wertebereich: 1-600s. Standard: "" - Proxy-/globale Einstellungen verwenden. Verhalten der Eigenschaft: - unterstützt, wenn type auf „Zabbix agent“ (0), „Simple check“ (3) gesetzt ist und key_ nicht mit „vmware.“ oder „icmpping“ beginnt, „Zabbix agent (active)“ (7), „External check“ (10), „Database monitor“ (11), „SSH agent“ (13), „TELNET agent“ (14), „HTTP agent“ (19), „SNMP agent“ (20) gesetzt ist und snmp_oid mit „walk[“ oder „get[“ beginnt, sowie „Script“ (21) oder „Browser“ (22)- schreibgeschützt für geerbte Objekte |
| trapper_hosts | string | Zulässige Hosts. Verhalten der Eigenschaft: - unterstützt, wenn type auf „Zabbix trapper“ gesetzt ist oder wenn type auf „HTTP agent“ und allow_traps auf „Allow incoming data“ gesetzt ist.Wenn die Eigenschaft nicht angegeben wird, wird sie automatisch auf das Benutzermakro {$TRAPPER.ALLOWED_HOSTS} gesetzt (Standardwert). Standardmäßig ist {$TRAPPER.ALLOWED_HOSTS} 127.0.0.1,::1.Wenn die Eigenschaft auf eine leere Zeichenfolge gesetzt ist, werden eingehende Verbindungen von allen Hosts abgelehnt. |
| trends | string | Zeiteinheit für die Dauer der Speicherung von Trenddaten. Akzeptiert außerdem ein Benutzermakro und ein LLD-Makro. Standard: 365d. Verhalten der Eigenschaft: - unterstützt, wenn value_type auf „numeric float“ oder „numeric unsigned“ gesetzt ist |
| units | string | Werteinheiten. Verhalten der Eigenschaft: - 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. Verhalten der Eigenschaft: - erforderlich, wenn type auf „SSH agent“ oder „TELNET agent“ gesetzt ist oder wenn type auf „JMX agent“ und password angegeben 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 eindeutiger Bezeichner, der zum Verknüpfen importierter Datenpunkt-Prototypen mit bereits vorhandenen Prototypen verwendet wird. Wird automatisch generiert, wenn er nicht angegeben ist. Verhalten der Eigenschaft: - unterstützt, wenn der Datenpunkt-Prototyp zu einer Vorlage gehört |
| valuemapid | ID | ID der zugehörigen Wertzuordnung. Verhalten der Eigenschaft: - unterstützt, wenn value_type auf „numeric float“, „character“ oder „numeric unsigned“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| verify_host | integer | Gibt an, ob überprüft werden soll, dass der Hostname der Verbindung mit dem Hostnamen im Zertifikat des Hosts übereinstimmt. Mögliche Werte: 0 - (Standard) Nicht überprüfen; 1 - Überprüfen. Verhalten der Eigenschaft: - unterstützt, wenn type auf „HTTP agent“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| verify_peer | integer | Gibt an, ob überprüft werden soll, dass das Zertifikat des Hosts authentisch ist. Mögliche Werte: 0 - (Standard) Nicht überprüfen; 1 - Überprüfen. Verhalten der Eigenschaft: - unterstützt, wenn type auf „HTTP agent“ gesetzt ist- schreibgeschützt für geerbte Objekte |
| discover | integer | Ermittlungsstatus des Datenpunkt-Prototyps. Mögliche Werte: 0 - (Standard) Neue Datenpunkte werden ermittelt; 1 - Neue Datenpunkte werden nicht ermittelt und vorhandene Datenpunkte als verloren markiert. |
| query | object | Konfiguration der Telemetry-Abfrage. Definiert, welche Daten der Datenpunkt aus der Telemetriedatenquelle abfragt, wie die Daten gefiltert werden und wie das Ergebnis aggregiert wird. Verhalten der Eigenschaft: - erforderlich, wenn type auf „Telemetry query“ gesetzt ist- schreibgeschützt für geerbte oder ermittelte Objekte |
| time_shift | string | Gibt an, wie weit vor der aktuellen Zeit der Zeitraum endet, den der Datenpunkt abfragt. Akzeptiert eine Anzahl von Sekunden (z. B. 1, 60, 300) oder einen Wert mit einem Zeit-Suffix (z. B. 30s, 1m, 2h, 1d). Akzeptiert außerdem Benutzermakros und LLD-Makros.Möglicher Wertebereich: 0-86400s. Standard: 15s. Verhalten der Eigenschaft: - unterstützt, wenn type auf „Telemetry query“ gesetzt ist |
| lookback_limit | string | Gibt an, wie weit vor der aktuellen Zeit der Datenpunkt Daten abfragt, wenn keine vorherige Abfrage vorhanden ist, von der aus fortgefahren werden kann (z. B. beim ersten Lauf des Datenpunkts), oder wenn die vorherige Abfrage älter als delay ist (z. B. weil der Zabbix Server nicht verfügbar war).Akzeptiert eine Anzahl von Sekunden (z. B. 1, 60, 300) oder einen Wert mit einem Zeit-Suffix (z. B. 30s, 1m, 2h, 1d). Akzeptiert außerdem Benutzermakros und LLD-Makros.Möglicher Wertebereich: 1-259200s. Standard: 10m. Verhalten der Eigenschaft: - unterstützt, wenn type auf „Telemetry query“ gesetzt ist |
| granularity | string | Länge eines Abschnitts, in den der gesamte Zeitraum der Abfrage aufgeteilt wird. Akzeptiert eine Anzahl von Sekunden (z. B. 1, 60, 300) oder einen Wert mit einem Zeit-Suffix (z. B. 30s, 1m, 2h, 1d). Akzeptiert außerdem Benutzermakros und LLD-Makros.Möglicher Wertebereich: 1-86400s. Standard: 15s. Verhalten der Eigenschaft: - unterstützt, wenn type auf „Telemetry query“ gesetzt ist |
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 |
Telemetrieabfrage
Das Telemetrieabfrageobjekt verfügt über die folgenden Eigenschaften.
| Property | Type | Description |
|---|---|---|
| signal_type | integer | Typ des Signals, den der Datenpunkt abfragt. Mögliche Werte: 0 - Traces; 1 - Metriken; 2 - Logs. Verhalten der Eigenschaft: - erforderlich |
| metric_point_type | integer | Typ des Metrikpunkts, den der Datenpunkt abfragt. Mögliche Werte: 0 - Summe; 1 - Gauge; 2 - Histogramm; 3 - Exponentielles Histogramm. Verhalten der Eigenschaft: - erforderlich, wenn signal_type auf „Metrics“ gesetzt ist |
| columns | array | Array von Telemetriedatenspalten, die der Datenpunkt abfragt. Kann leer sein. Verhalten der Eigenschaft: - erforderlich |
| aggregated_columns | array | Array von aggregierten Telemetriedatenspalten, die der Datenpunkt abfragt, sowie die Art und Weise, wie aus den Spalteneinträgen ein Wert berechnet wird. Verhalten der Eigenschaft: - erforderlich |
| filter | object | Filter der Telemetrieabfrage für Spalteneinträge in der Abfrage. Verhalten der Eigenschaft: - erforderlich |
Spalten für Telemetriedaten
Das Objekt für Spalten mit Telemetriedaten verfügt über die folgenden Eigenschaften.
| Property | Type | Description |
|---|---|---|
| column | string | Name der Spalte mit Telemetriedaten, die der Datenpunkt abfragt. Siehe unterstützte Spalten für Telemetriedaten. Bei mehreren Spalten mit jeweils einem Wert muss jeder column-Wert eindeutig sein. Bei mehreren Spalten, die Schlüssel-Wert-Paare enthalten, muss jedes Paar aus column und attribute_key eindeutig sein. |
| attribute_key | string | Name des Schlüssels, den der Datenpunkt innerhalb der Spalte mit Schlüssel-Wert-Paaren abfragt. Bei mehreren Spalten, die Schlüssel-Wert-Paare enthalten, muss jedes Paar aus column und attribute_key eindeutig sein.Verhalten der Eigenschaft: - required, wenn column auf eine Spalte gesetzt ist, die Schlüssel-Wert-Paare enthält |
Aggregierte Spalten von Telemetriedaten
Das Objekt für aggregierte Spalten von Telemetriedaten verfügt über die folgenden Eigenschaften.
| Property | Type | Description |
|---|---|---|
| column | string | Name der Telemetriedatenspalte, die der Datenpunkt abfragt. Siehe unterstützte Telemetriedatenspalten. Bei mehreren Spalten muss jeder column-Wert eindeutig sein.Diese Eigenschaft wird nicht unterstützt, wenn function auf „Count“ gesetzt ist.Verhalten der Eigenschaft: - erforderlich, wenn function auf „Min“, „Max“, „Average“, „Sum“ oder „Percentile“ gesetzt ist |
| function | integer | Funktion, die der Datenpunkt auf die Spalteneinträge anwendet. Mögliche Werte: 1 - Min; 2 - Max; 3 - Average; 4 - Count; 5 - Sum; 8 - Percentile. Verhalten der Eigenschaft: - erforderlich |
| parameters | array | Perzentil, das der Datenpunkt aus den Spalteneinträgen berechnet. Möglicher Wert: eine Zahl von 0 bis 100, angegeben als Zeichenkette. Verhalten der Eigenschaft: - erforderlich, wenn function auf „Percentile“ gesetzt ist |
| alias | string | Eindeutiger Name für den berechneten Wert, der zur Identifizierung in dem Datenpunktwert verwendet wird. Jeder alias-Wert muss eindeutig sein.Verhalten der Eigenschaft: - erforderlich |
Telemetriedatenfilter
Das Objekt für den Telemetriedatenfilter verfügt über die folgenden Eigenschaften.
| Property | Type | Description |
|---|---|---|
| conditions | array | Bedingungen des Telemetriedatenfilters, die ein Datensatz in einer Telemetriedatenspalte erfüllen muss. Verhalten der Eigenschaft: - erforderlich |
| evaltype | integer | Auswertungsmethode der Filterbedingung. Mögliche Werte: 0 - Und/Oder; 1 - Und; 2 - Oder; 3 - Benutzerdefinierter Ausdruck. Verhalten der Eigenschaft: - erforderlich |
| eval_formula | string | Generierter Ausdruck, der zur Auswertung der Filterbedingungen verwendet wird. Der Ausdruck enthält IDs, die über ihre formulaid auf bestimmte Filterbedingungen verweisen. Der Wert von eval_formula entspricht dem Wert von formula für Filter mit einem benutzerdefinierten Ausdruck.Verhalten der Eigenschaft: - schreibgeschützt |
| formula | string | Benutzerdefinierter Ausdruck zur Auswertung der Bedingungen von Filtern mit einem benutzerdefinierten Ausdruck. Der Ausdruck muss IDs enthalten, die auf bestimmte Filterbedingungen über ihre formulaid verweisen. Die im Ausdruck verwendeten IDs müssen genau mit den in den Filterbedingungen definierten IDs übereinstimmen: Keine Bedingung darf ungenutzt bleiben oder ausgelassen werden.Verhalten der Eigenschaft: - erforderlich, wenn evaltype auf „Benutzerdefinierter Ausdruck“ gesetzt ist |
Bedingungen für den Telemetriedatenfilter
Das Objekt für die Bedingungen des Telemetriedatenfilters verfügt über die folgenden Eigenschaften.
| Property | Type | Description |
|---|---|---|
| column | string | Name der Telemetriedatenspalte, auf die die Filterbedingung angewendet wird. Siehe unterstützte Telemetriedatenspalten. Verhalten der Eigenschaft: - erforderlich |
| attribute_key | string | Name des Schlüssels, auf den die Bedingung innerhalb der Spalte angewendet wird, die Schlüssel-Wert-Paare enthält. Verhalten der Eigenschaft: - erforderlich, wenn column auf eine Spalte festgelegt ist, die Schlüssel-Wert-Paare enthält |
| operator | integer | Operator der Filterbedingung. Mögliche Werte für Spalten mit Einzelwerten: 0 - Ist gleich; 1 - Ist nicht gleich; 2 - Enthält; 3 - Enthält nicht. Mögliche Werte für Spalten, die Schlüssel-Wert-Paare enthalten: 0 - Ist gleich; 1 - Ist nicht gleich; 12 - Ist vorhanden. Verhalten der Eigenschaft: - erforderlich |
| value | string | Wert, mit dem verglichen werden soll. Verhalten der Eigenschaft: - erforderlich, wenn operator auf „Ist gleich“, „Ist nicht gleich“, „Enthält“ oder „Enthält nicht“ festgelegt ist |
| formulaid | string | Beliebige eindeutige ID, die verwendet wird, um in einem benutzerdefinierten Ausdruck auf die Bedingung zu verweisen. Darf nur Großbuchstaben enthalten. Die ID muss vom Benutzer beim Ändern von Filterbedingungen definiert werden, wird jedoch bei einer anschließenden Abfrage neu generiert. Verhalten der Eigenschaft: - erforderlich, wenn evaltype des Objekts Telemetriedatenabfragefilter auf „Benutzerdefinierter Ausdruck“ festgelegt ist |
Tag des Datenpunktprototyps
Das Tag-Objekt des Datenpunktprototyps hat die folgenden Eigenschaften.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| tag | string | Name des Tags des Datenpunktprototyps. Verhalten der Eigenschaft: - erforderlich |
| value | string | Wert des Tags des Datenpunktprototyps. Verhalten der Eigenschaft: - schreibgeschützt. |
| object | integer | Typ des Objekts, von dem das Tag geerbt wurde. Mögliche Werte: 0 - Vorlage; 1 - Host. Verhalten der Eigenschaft: - schreibgeschützt. |
| objectid | ID | ID des Objekts, von dem das Tag geerbt wurde. Verhalten der Eigenschaft: - schreibgeschützt. |
Vorverarbeitung des Datenpunkt-Prototyps
Das Vorverarbeitungsobjekt des Datenpunkt-Prototyps verfügt über die folgenden Eigenschaften.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| 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 in Dezimalzahl; 7 - Oktal in Dezimalzahl; 8 - Hexadezimal in Dezimalzahl; 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 - Mit regulärem Ausdruck auf Fehler prüfen; 19 - Unveränderte Werte verwerfen; 20 - Unveränderte Werte mit Heartbeat verwerfen; 21 - JavaScript; 22 - Prometheus-Muster; 23 - Prometheus in JSON; 24 - CSV in JSON; 25 - Ersetzen; 26 - Nicht unterstützten Wert prüfen; 27 - XML in JSON; 28 - SNMP-Walk-Wert; 29 - SNMP-Walk in JSON; 30 - SNMP-Get-Wert. Verhalten der Eigenschaft: - erforderlich |
| params | string | Zusätzliche Parameter, die von der Vorverarbeitungsoption verwendet werden. Mehrere Parameter werden durch das Zeilenumbruchzeichen (\n) getrennt. Wenn type auf „Nicht unterstützten Wert prüfen“ gesetzt ist, folgen die Parameter der Syntax <scope>[\n<pattern>], wobei pattern ein regulärer Ausdruck ist und scope einem der folgenden Werte entspricht:-1 - jeden Fehler abgleichen; \ 0 - prüfen, ob die Fehlermeldung mit pattern übereinstimmt; \ 1 - prüfen, ob die Fehlermeldung nicht mit pattern übereinstimmt. Verhalten der Eigenschaft: - erforderlich, wenn type auf „Benutzerdefinierter Multiplikator“ (1), „Rechts trimmen“ (2), „Links trimmen“ (3), „Trimmen“ (4), „Regulärer Ausdruck“ (5), „XML XPath“ (11), „JSONPath“ (12), „Im Bereich“ (13), „Entspricht regulärem Ausdruck“ (14), „Entspricht nicht regulärem Ausdruck“ (15), „Auf Fehler in JSON prüfen“ (16), „Auf Fehler in XML prüfen“ (17), „Mit regulärem Ausdruck auf Fehler prüfen“ (18), „Unveränderte Werte mit Heartbeat verwerfen“ (20), „JavaScript“ (21), „Prometheus-Muster“ (22), „Prometheus in JSON“ (23), „CSV in JSON“ (24), „Ersetzen“ (25), „Nicht unterstützten Wert prüfen“ (26), „SNMP-Walk-Wert“ (28), „SNMP-Walk in JSON“ (29) oder „SNMP-Get-Wert“ (30) gesetzt ist |
| error_handler | integer | Aktionstyp, der bei einem Fehler in einem Vorverarbeitungsschritt verwendet wird. Mögliche Werte: 0 - Fehlermeldung wird vom Zabbix Server festgelegt; 1 - Wert verwerfen; 2 - Benutzerdefinierten Wert festlegen; 3 - Benutzerdefinierte Fehlermeldung festlegen. Mögliche Werte, wenn type auf „Nicht unterstützten Wert prüfen“ gesetzt ist:1 - Wert verwerfen; 2 - Benutzerdefinierten Wert festlegen; 3 - Benutzerdefinierte Fehlermeldung festlegen. Verhalten der Eigenschaft: - erforderlich, wenn type auf „Benutzerdefinierter Multiplikator“ (1), „Regulärer Ausdruck“ (5), „Boolesch in Dezimalzahl“ (6), „Oktal in Dezimalzahl“ (7), „Hexadezimal in Dezimalzahl“ (8), „Einfache Änderung“ (9), „Änderung pro Sekunde“ (10), „XML XPath“ (11), „JSONPath“ (12), „Im Bereich“ (13), „Entspricht regulärem Ausdruck“ (14), „Entspricht nicht regulärem Ausdruck“ (15), „Auf Fehler in JSON prüfen“ (16), „Auf Fehler in XML prüfen“ (17), „Mit regulärem Ausdruck auf Fehler prüfen“ (18), „Prometheus-Muster“ (22), „Prometheus in JSON“ (23), „CSV in JSON“ (24), „Nicht unterstützten Wert prüfen“ (26), „XML in JSON“ (27), „SNMP-Walk-Wert“ (28), „SNMP-Walk in JSON“ (29) oder „SNMP-Get-Wert“ (30) gesetzt ist |
| error_handler_params | string | Parameter des Fehlerhandlers. Verhalten der Eigenschaft: - erforderlich, wenn error_handler auf „Benutzerdefinierten Wert festlegen“ oder „Benutzerdefinierte Fehlermeldung festlegen“ gesetzt ist |
Die folgenden Parameter und Fehlerhandler werden für jeden Vorverarbeitungstyp unterstützt.
| Vorverarbeitungstyp | Name | Parameter 1 | Parameter 2 | Parameter 3 | Unterstützte Fehlerhandler |
|---|---|---|---|---|---|
| 1 | Benutzerdefinierter Multiplikator | number1, 6 | 0, 1, 2, 3 | ||
| 2 | Rechts trimmen | Liste von Zeichen2 | |||
| 3 | Links trimmen | Liste von Zeichen2 | |||
| 4 | Trimmen | Liste von Zeichen2 | |||
| 5 | Regulärer Ausdruck | pattern3 | output2 | 0, 1, 2, 3 | |
| 6 | Boolesch in Dezimalzahl | 0, 1, 2, 3 | |||
| 7 | Oktal in Dezimalzahl | 0, 1, 2, 3 | |||
| 8 | Hexadezimal in Dezimalzahl | 0, 1, 2, 3 | |||
| 9 | Einfache Änderung | 0, 1, 2, 3 | |||
| 10 | Änderung pro Sekunde | 0, 1, 2, 3 | |||
| 11 | XML XPath | path4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | path4 | 0, 1, 2, 3 | ||
| 13 | Im Bereich | min1, 6 | max1, 6 | 0, 1, 2, 3 | |
| 14 | Entspricht regulärem Ausdruck | pattern3 | 0, 1, 2, 3 | ||
| 15 | Entspricht nicht regulärem Ausdruck | pattern3 | 0, 1, 2, 3 | ||
| 16 | Auf Fehler in JSON prüfen | path4 | 0, 1, 2, 3 | ||
| 17 | Auf Fehler in XML prüfen | path4 | 0, 1, 2, 3 | ||
| 18 | Mit regulärem Ausdruck auf Fehler prüfen | pattern3 | output2 | 0, 1, 2, 3 | |
| 19 | Unveränderte Werte verwerfen | ||||
| 20 | Unveränderte Werte mit Heartbeat verwerfen | seconds5, 6 | |||
| 21 | JavaScript | script2 | |||
| 22 | Prometheus-Muster | 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 | character2 | character2 | 0,1 | 0, 1, 2, 3 |
| 25 | Ersetzen | search string2 | replacement2 | ||
| 26 | Nicht unterstützten Wert prüfen | scope1 | pattern3, 6 | 1, 2, 3 | |
| 27 | XML in JSON | 0, 1, 2, 3 | |||
| 28 | SNMP-Walk-Wert | OID2 | Format: 0 - Unverändert 1 - UTF-8 aus Hex-STRING 2 - MAC aus Hex-STRING 3 - Ganzzahl aus BITS |
0, 1, 2, 3 | |
| 29 | SNMP-Walk in JSON10 | Field name2 | OID prefix2 | Format: 0 - Unverändert 1 - UTF-8 aus Hex-STRING 2 - MAC aus Hex-STRING 3 - Ganzzahl aus BITS |
0, 1, 2, 3 |
| 30 | SNMP-Get-Wert | Format: 1 - UTF-8 aus Hex-STRING 2 - MAC aus Hex-STRING 3 - Ganzzahl aus BITS |
0, 1, 2, 3 | ||
1 Ganzzahl oder Gleitkommazahl
2 Zeichenkette
3 Regulärer Ausdruck
4 JSONPath oder XML XPath
5 Positive Ganzzahl (mit Unterstützung von Zeitsuffixen, z. B. 30s, 1m, 2h, 1d)
6 Benutzermakro, LLD-Makro
7 Prometheus-Muster gemäß der Syntax: <metric name>{<label name>="<label value>", ...} == <value>.
Jede Komponente des Prometheus-Musters (Metrik, Labelname, Labelwert und Metrikwert) kann ein Benutzermakro oder LLD-Makro sein.
8 Prometheus-Ausgabe gemäß der Syntax: <label name> (kann ein Benutzermakro oder LLD-Makro sein), wenn label als zweiter Parameter ausgewählt ist.
9 Eine der Aggregationsfunktionen: sum, min, max, avg, count, wenn function als zweiter Parameter ausgewählt ist.
10 Unterstützt mehrere Datensätze im Format „Field name,OID prefix,Format“, die durch ein Zeilenumbruchzeichen getrennt sind.