Vienuma objekts

Tālāk norādītie objekti ir tieši saistīti ar vienums API.

Vienums

Tīmekļa vienumus nevar tieši izveidot, atjaunināt vai dzēst, izmantojot Zabbix API.

Vienuma objektam ir šādi rekvizīti.

Rekvizīts Tips Apraksts
itemid ID Vienuma ID.

Rekvizīta darbība:
- tikai lasāms
- obligāts atjaunināšanas darbībām
delay string Vienuma atjaunināšanas intervāls.

Pieņem sekunžu skaitu (piemēram, 1, 60, 300), vērtību ar laika sufiksu (piemēram, 30s, 1m, 2h, 1d) vai, pēc izvēles, vienu vai vairākus pielāgotus intervālus, kas atdalīti ar semikoliem. Pielāgotie intervāli var būt elastīgo un plānošanas intervālu kombinācija.

Pieņem lietotāja makro. Ja tiek izmantots makro, vērtībai jābūt vienam makro. Vairāki makro vai makro kombinācijā ar tekstu netiek atbalstīti. Elastīgos intervālus var norādīt kā divus makro, kas atdalīti ar slīpsvītru (piemēram, {$FLEX_INTERVAL}/{$FLEX_PERIOD}).

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

Rekvizīta darbība:
- obligāts, ja type ir iestatīts uz "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) vai ja type ir iestatīts uz "Zabbix agent (active)" (7) un key_ nesatur "mqtt.get"
hostid ID Hosts vai veidnes, kurai pieder vienums, ID.

Rekvizīta darbība:
- konstants
- obligāts izveides darbībām
interfaceid ID Vienuma hosts saskarnes ID.

Rekvizīta darbība:
- obligāts, ja vienums pieder hostam un type ir iestatīts uz "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap" vai "SNMP agent"
- atbalstīts, ja vienums pieder hostam un type ir iestatīts uz "Simple check", "External check", "SSH agent", "TELNET agent" vai "HTTP agent"
- tikai lasāms atklātajiem objektiem
key_ string Vienuma atslēga.

Rekvizīta darbība:
- obligāta izveides darbībām
- tikai lasāma mantotajiem vai atklātajiem objektiem
name string Vienuma nosaukums.
Atbalsta lietotāja makro.

Rekvizīta darbība:
- obligāts izveides darbībām
- tikai lasāms mantotajiem vai atklātajiem objektiem
name_resolved string Vienuma nosaukums ar atrisinātiem lietotāja makro.

Rekvizīta darbība:
- tikai lasāms
type integer Vienuma tips.

Iespējamās vērtības:
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;
24 - Telemetry query.

Rekvizīta darbība:
- obligāts izveides darbībām
- tikai lasāms mantotajiem vai atklātajiem objektiem
url string URL virkne.
Atbalsta lietotāja makro, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}.

Rekvizīta darbība:
- obligāts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
value_type integer Vienuma informācijas tips.

Iespējamās vērtības:
0 - skaitlis ar peldošo komatu;
1 - rakstzīme;
2 - žurnāls;
3 - vesels skaitlis bez zīmes;
4 - teksts;
5 - binārs;
6 - JSON.

Rekvizīta darbība:
- obligāts izveides darbībām
- tikai lasāms mantotajiem vai atklātajiem objektiem
allow_traps integer Atļaut aizpildīt vērtību tāpat kā trapper vienumam.

0 - (noklusējums) nepieņemt ienākošos datus;
1 - pieņemt ienākošos datus.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms atklātajiem objektiem
authtype integer Autentifikācijas metode.

Iespējamās vērtības, ja type ir iestatīts uz "SSH agent":
0 - (noklusējums) parole;
1 - publiskā atslēga.

Iespējamās vērtības, ja type ir iestatīts uz "HTTP agent":
0 - (noklusējums) nav;
1 - pamata;
2 - NTLM;
3 - Kerberos;
4 - Digest.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "SSH agent" vai "HTTP agent"
- tikai lasāms mantotajiem objektiem (ja type ir iestatīts uz "HTTP agent") vai atklātajiem objektiem
description string Vienuma apraksts.

Rekvizīta darbība:
- tikai lasāms atklātajiem objektiem
error string Kļūdas teksts, ja rodas problēmas ar vienuma vērtības atjaunināšanu.

Rekvizīta darbība:
- tikai lasāms
flags integer Vienuma izcelsme.

Iespējamās vērtības:
0 - parasts vienums;
4 - no prototipa pārveidots vienums.

Rekvizīta darbība:
- tikai lasāms
follow_redirects integer Sekot atbildes novirzēm datu aptaujas laikā.

Iespējamās vērtības:
0 - nesekot novirzēm;
1 - (noklusējums) sekot novirzēm.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
headers array Galveņu masīvs, kas tiks nosūtīts, veicot HTTP pieprasījumu.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
history string Laika vienība, kas nosaka, cik ilgi jāglabā vēstures dati.
Pieņem arī lietotāja makro.

Noklusējums: 31d.

Rekvizīta darbība:
- tikai lasāms atklātajiem objektiem
http_proxy string HTTP(S) starpniekservera savienojuma virkne.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
inventory_link integer Hosts inventarizācijas lauka ID, ko aizpilda vienums.

Atbalstīto hosts inventarizācijas lauku un to ID sarakstu skatiet hosts inventarizācijas lapā.

Noklusējums: 0.

Rekvizīta darbība:
- atbalstīts, ja value_type ir iestatīts uz "numeric float", "character", "numeric unsigned" vai "text"
- tikai lasāms atklātajiem objektiem
ipmi_sensor string IPMI sensors.

Rekvizīta darbība:
- obligāts, ja type ir iestatīts uz "IPMI agent" un key_ nav iestatīts uz "ipmi.get"
- atbalstīts, ja type ir iestatīts uz "IPMI agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
jmx_endpoint string JMX aģenta pielāgotā savienojuma virkne.

Noklusējuma vērtība: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "JMX agent"
- tikai lasāms atklātajiem objektiem
lastclock timestamp Laiks, kad vienuma vērtība pēdējo reizi tika atjaunināta.

Pēc noklusējuma tiek rādītas tikai vērtības, kas ietilpst pēdējo 24 stundu periodā. Šo periodu var pagarināt, mainot parametra Max history display period vērtību izvēlnes sadaļā Administration > General.

Rekvizīta darbība:
- tikai lasāms
lastns integer Nanosekundes, kad vienuma vērtība pēdējo reizi tika atjaunināta.

Pēc noklusējuma tiek rādītas tikai vērtības, kas ietilpst pēdējo 24 stundu periodā. Šo periodu var pagarināt, mainot parametra Max history display period vērtību izvēlnes sadaļā Administration > General.

Rekvizīta darbība:
- tikai lasāms
lastvalue string Pēdējā vienuma vērtība.

Pēc noklusējuma tiek rādītas tikai vērtības, kas ietilpst pēdējo 24 stundu periodā. Šo periodu var pagarināt, mainot parametra Max history display period vērtību izvēlnes sadaļā Administration > General.

Rekvizīta darbība:
- tikai lasāms
logtimefmt string Laika formāts žurnāla ierakstos.

Rekvizīta darbība:
- atbalstīts, ja value_type ir iestatīts uz "log"
- tikai lasāms mantotajiem vai atklātajiem objektiem
master_itemid ID Galvenā vienuma ID.

Rekvizīta darbība:
- obligāts, ja type ir iestatīts uz "Dependent item"
- tikai lasāms mantotajiem vai atklātajiem objektiem
output_format integer Vai atbilde jāpārveido par JSON.

0 - (noklusējums) saglabāt neapstrādātus datus;
1 - pārveidot par JSON.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
params string Papildu parametri atkarībā no vienuma tipa:
- izpildāmais skripts SSH agent un TELNET agent vienumiem;
- SQL vaicājums database monitor vienumiem;
- formula calculated vienumiem;
- skripts script un browser vienumiem.

Rekvizīta darbība:
- obligāts, ja type ir iestatīts uz "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script" vai "Browser"
- tikai lasāms mantotajiem objektiem (ja type ir iestatīts uz "Script" vai "Browser") vai atklātajiem objektiem
parameters object/array Papildu parametri, ja type ir iestatīts uz "Script" vai "Browser". Objektu masīvs ar name un value rekvizītiem, kur name jābūt unikālam.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "Script" vai "Browser"
- tikai lasāms mantotajiem vai atklātajiem objektiem
password string Parole autentifikācijai.

Rekvizīta darbība:
- obligāta, ja type ir iestatīts uz "JMX agent" un username ir iestatīts
- atbalstīta, ja type ir iestatīts uz "Simple check", "SSH agent", "TELNET agent", "Database monitor" vai "HTTP agent"
- tikai lasāma mantotajiem objektiem (ja type ir iestatīts uz "HTTP agent") vai atklātajiem objektiem
post_type integer posts rekvizītā saglabāto POST datu pamatteksta tips.

Iespējamās vērtības:
0 - (noklusējums) neapstrādāti dati;
2 - JSON dati;
3 - XML dati.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
posts string HTTP(S) pieprasījuma pamatteksta dati.

Rekvizīta darbība:
- obligāti, ja type ir iestatīts uz "HTTP agent" un post_type ir iestatīts uz "JSON data" vai "XML data"
- atbalstīti, ja type ir iestatīts uz "HTTP agent" un post_type ir iestatīts uz "Raw data"
- tikai lasāmi mantotajiem vai atklātajiem objektiem
prevvalue string Iepriekšējā vienuma vērtība.

Pēc noklusējuma tiek rādītas tikai vērtības, kas ietilpst pēdējo 24 stundu periodā. Šo periodu var pagarināt, mainot parametra Max history display period vērtību izvēlnes sadaļā Administration > General.

Rekvizīta darbība:
- tikai lasāms
privatekey string Privātās atslēgas faila nosaukums.

Rekvizīta darbība:
- obligāts, ja type ir iestatīts uz "SSH agent" un authtype ir iestatīts uz "public key"
- tikai lasāms atklātajiem objektiem
publickey string Publiskās atslēgas faila nosaukums.

Rekvizīta darbība:
- obligāts, ja type ir iestatīts uz "SSH agent" un authtype ir iestatīts uz "public key"
- tikai lasāms atklātajiem objektiem
query_fields array Vaicājuma lauku masīvs, kas tiks nosūtīts, veicot HTTP pieprasījumu.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
request_method integer Pieprasījuma metodes tips.

Iespējamās vērtības:
0 - (noklusējums) GET;
1 - POST;
2 - PUT;
3 - HEAD.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
retrieve_mode integer Kura atbildes daļa jāsaglabā.

Iespējamās vērtības, ja request_method ir iestatīts uz "GET", "POST" vai "PUT":
0 - (noklusējums) pamatteksts;
1 - galvenes;
2 - tiks saglabāts gan pamatteksts, gan galvenes.

Iespējamā vērtība, ja request_method ir iestatīts uz "HEAD":
1 - galvenes.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
snmp_oid string SNMP OID.

Rekvizīta darbība:
- obligāts, ja type ir iestatīts uz "SNMP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
ssl_cert_file string Publiskās SSL atslēgas faila ceļš.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
ssl_key_file string Privātās SSL atslēgas faila ceļš.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
ssl_key_password string SSL atslēgas faila parole.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
state integer Vienuma stāvoklis.

Iespējamās vērtības:
0 - (noklusējums) normāls;
1 - netiek atbalstīts.

Rekvizīta darbība:
- tikai lasāms
status integer Vienuma statuss.

Iespējamās vērtības:
0 - (noklusējums) iespējots vienums;
1 - atspējots vienums.
status_codes string Nepieciešamo HTTP statusa kodu diapazoni, atdalīti ar komatiem.
Atbalsta arī lietotāja makro kā daļu no ar komatiem atdalīta saraksta.

Piemērs: 200,200-{$M},{$M},200-400

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
templateid ID Vecākā veidnes vienuma ID.

Padoms: izmantojiet hostid rekvizītu, lai norādītu veidni, kurai pieder vienums.

Rekvizīta darbība:
- tikai lasāms
timeout string Vienuma datu aptaujas pieprasījuma taimauts.
Pieņem sekunžu skaitu (piemēram, 1, 60, 300) vai vērtību ar laika sufiksu (piemēram, 300s, 1m). Pieņem arī lietotāja makro.

Iespējamo vērtību diapazons: 1-600s.

Noklusējums: "" - izmantot starpniekservera/globālos iestatījumus.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "Zabbix agent" (0), "Simple check" (3) un key_ nesākas ar "vmware." un "icmpping", "Zabbix agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH agent" (13), "TELNET agent" (14), "HTTP agent" (19), "SNMP agent" (20) un snmp_oid sākas ar "walk[" vai "get[", "Script" (21), "Browser" (22)
- tikai lasāms mantotajiem un atklātajiem objektiem,
- ja tiek lietota noklusējuma vērtība un vienums pieder hostam, ko uzrauga nepieejams starpniekserveris vai starpniekserveru grupa, tiek izmantots globālais taimauts.
trapper_hosts string Atļautie hosti.

Rekvizīta darbība:
- tikai lasāms atklātajiem objektiem
- atbalstīts, ja type ir iestatīts uz "Zabbix trapper" vai ja type ir iestatīts uz "HTTP agent" un allow_traps ir iestatīts uz "Allow to accept incoming data".
Ja rekvizīts nav norādīts, tam automātiski tiek iestatīts {$TRAPPER.ALLOWED_HOSTS} lietotāja makro (noklusējuma vērtība). Pēc noklusējuma {$TRAPPER.ALLOWED_HOSTS} ir 127.0.0.1,::1.
Ja rekvizīts ir iestatīts uz tukšu virkni, ienākošie savienojumi no visiem hostiem tiks noraidīti.
trends string Laika vienība, kas nosaka, cik ilgi jāglabā tendenču dati.
Pieņem arī lietotāja makro.

Noklusējums: 365d.

Rekvizīta darbība:
- atbalstīts, ja value_type ir iestatīts uz "numeric float" vai "numeric unsigned"
- tikai lasāms atklātajiem objektiem
units string Vērtības mērvienības.

Rekvizīta darbība:
- atbalstīts, ja value_type ir iestatīts uz "numeric float" vai "numeric unsigned"
- tikai lasāms mantotajiem vai atklātajiem objektiem
username string Lietotājvārds autentifikācijai.

Rekvizīta darbība:
- obligāts, ja type ir iestatīts uz "SSH agent", "TELNET agent" vai ja type ir iestatīts uz "JMX agent" un password ir iestatīts
- atbalstīts, ja type ir iestatīts uz "Simple check", "Database monitor" vai "HTTP agent"
- tikai lasāms mantotajiem objektiem (ja type ir iestatīts uz "HTTP agent") vai atklātajiem objektiem
uuid string Universāls unikāls identifikators, ko izmanto importētā vienuma sasaistīšanai ar jau esošiem vienumiem. Ja nav norādīts, tas tiek ģenerēts automātiski.

Rekvizīta darbība:
- atbalstīts, ja vienums pieder veidnei
valuemapid ID Saistītās vērtību kartes ID.

Rekvizīta darbība:
- atbalstīts, ja value_type ir iestatīts uz "numeric float", "character" vai "numeric unsigned"
- tikai lasāms mantotajiem vai atklātajiem objektiem
verify_host integer Vai pārbaudīt, ka savienojuma hosts nosaukums atbilst hosts sertifikātā norādītajam nosaukumam.

Iespējamās vērtības:
0 - (noklusējums) nepārbaudīt;
1 - pārbaudīt.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
verify_peer integer Vai pārbaudīt, ka hosts sertifikāts ir autentisks.

Iespējamās vērtības:
0 - (noklusējums) nepārbaudīt;
1 - pārbaudīt.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "HTTP agent"
- tikai lasāms mantotajiem vai atklātajiem objektiem
query object Telemetrijas vaicājuma konfigurācija. Nosaka, ko vienums vaicā telemetrijas datu avotā, kā tas filtrē datus un kā apkopo rezultātu.

Rekvizīta darbība:
- obligāts, ja type ir iestatīts uz "Telemetry query"
- tikai lasāms mantotajiem vai atklātajiem objektiem
time_shift string Cik tālu pagātnē (pirms pašreizējā laika) beidzas laika diapazons, par kuru vienums veic vaicājumu.

Pieņem sekunžu skaitu (piemēram, 1, 60, 300) vai vērtību ar laika sufiksu (piemēram, 30s, 1m, 2h, 1d). Pieņem arī lietotāja makro.

Iespējamo vērtību diapazons: 0-86400s.

Noklusējums: 15s.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "Telemetry query"
lookback_limit string Cik tālu pagātnē (pirms pašreizējā laika) vienums veic datu vaicājumu, ja nav iepriekšēja vaicājuma, no kura turpināt (piemēram, vienuma pirmās palaišanas reizē), vai ja iepriekšējais vaicājums ir vecāks par delay (piemēram, tāpēc, ka Zabbix serveris nedarbojās).

Pieņem sekunžu skaitu (piemēram, 1, 60, 300) vai vērtību ar laika sufiksu (piemēram, 30s, 1m, 2h, 1d). Pieņem arī lietotāja makro.

Iespējamo vērtību diapazons: 1-259200s.

Noklusējums: 10m.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "Telemetry query"
granularity string Tā segmenta ilgums, kurā tiek sadalīts viss vaicājuma laika diapazons.

Pieņem sekunžu skaitu (piemēram, 1, 60, 300) vai vērtību ar laika sufiksu (piemēram, 30s, 1m, 2h, 1d). Pieņem arī lietotāja makro.

Iespējamo vērtību diapazons: 1-86400s.

Noklusējums: 15s.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "Telemetry query"

HTTP galvene

Galvenes objektam ir šādas īpašības:

Īpašība Tips Apraksts
name string HTTP galvenes nosaukums.

Īpašības darbība:
- obligāts
value string Galvenes vērtība.

Īpašības darbība:
- obligāts

HTTP vaicājuma lauks

Vaicājuma lauka objekts definē nosaukumu un vērtību, ko izmanto URL parametra norādīšanai. Tam ir šādas īpašības:

Īpašība Tips Apraksts
name string Parametra nosaukums.

Īpašības darbība:
- obligāta
value string Parametra vērtība.

Īpašības darbība:
- obligāta

Telemetrijas vaicājums

Telemetrijas vaicājuma objektam ir šādi rekvizīti.

Rekvizīts Tips Apraksts
signal_type integer Signāla tips, ko vaicā vienums.

Iespējamās vērtības:
0 - Traces;
1 - Metrics;
2 - Logs.

Rekvizīta darbība:
- obligāts
metric_point_type integer Metrikas punkta tips, ko vaicā vienums.

Iespējamās vērtības:
0 - Sum;
1 - Gauge;
2 - Histogram;
3 - Exponential histogram.

Rekvizīta darbība:
- obligāts, ja signal_type ir iestatīts uz "Metrics"
columns array Telemetrijas datu kolonnu masīvs, ko vaicā vienums. Var būt tukšs.

Rekvizīta darbība:
- obligāts
aggregated_columns array Telemetrijas datu apkopoto kolonnu masīvs, ko vaicā vienums, un veids, kā tas aprēķina vērtību no kolonnu ierakstiem.

Rekvizīta darbība:
- obligāts
filter object Telemetrijas vaicājuma filtrs vaicājuma kolonnu ierakstiem.

Rekvizīta darbība:
- obligāts
Telemetrijas datu kolonnas

Telemetrijas datu kolonnu objektam ir šādas īpašības.

Property Type Description
column string Telemetrijas datu kolonnas nosaukums, ko vaicā vienums.
Skatiet atbalstītās telemetrijas datu kolonnas.

Vairākām vienas vērtības kolonnām katrai column vērtībai ir jābūt unikālai. Vairākām kolonnām, kurās tiek glabāti atslēgu un vērtību pāri, katram column un attribute_key pārim ir jābūt unikālam.
attribute_key string Atslēgas nosaukums, ko vaicā vienums, kolonnā, kurā tiek glabāti atslēgu un vērtību pāri.

Vairākām kolonnām, kurās tiek glabāti atslēgu un vērtību pāri, katram column un attribute_key pārim ir jābūt unikālam.

Īpašības darbība:
- obligāts, ja column ir iestatīts uz kolonnu, kurā tiek glabāti atslēgu un vērtību pāri
Telemetrijas datu apkopoto kolonnu objekts

Telemetrijas datu apkopoto kolonnu objektam ir šādas īpašības.

Property Type Description
column string Telemetrijas datu kolonnas nosaukums, ko vaicā vienums.
Skatiet atbalstītās telemetrijas datu kolonnas.

Ja ir vairākas kolonnas, katrai column vērtībai ir jābūt unikālai.

Šī īpašība netiek atbalstīta, ja function ir iestatīts uz "Count".

Īpašības darbība:
- obligāta, ja function ir iestatīts uz "Min", "Max", "Average", "Sum" vai "Percentile"
function integer Funkcija, ko vienums lieto kolonnas ierakstiem.

Iespējamās vērtības:
1 - Min;
2 - Max;
3 - Average;
4 - Count;
5 - Sum;
8 - Percentile.

Īpašības darbība:
- obligāta
parameters array Procentile, ko vienums aprēķina no kolonnas ierakstiem.

Iespējamā vērtība: skaitlis no 0 līdz 100, kas norādīts kā virkne.

Īpašības darbība:
- obligāta, ja function ir iestatīts uz "Percentile"
alias string Unikāls aprēķinātās vērtības nosaukums, ko izmanto tās identificēšanai vienuma vērtībā.

Katrai alias vērtībai ir jābūt unikālai.

Īpašības darbība:
- obligāta
Telemetrijas datu filtrs

Telemetrijas datu filtra objektam ir šādas īpašības.

Property Type Description
conditions array Telemetrijas datu filtra nosacījumi, kuriem jāatbilst ierakstam telemetrijas datu kolonnā.

Īpašības darbība:
- obligāts
evaltype integer Filtra nosacījumu novērtēšanas metode.

Iespējamās vērtības:
0 - And/Or;
1 - And;
2 - Or;
3 - Pielāgota izteiksme.

Īpašības darbība:
- obligāts
eval_formula string Ģenerēta izteiksme, kas tiks izmantota filtra nosacījumu novērtēšanai. Izteiksme satur ID, kas atsaucas uz konkrētiem filtra nosacījumiem, izmantojot to formulaid. eval_formula vērtība ir vienāda ar formula vērtību filtriem ar pielāgotu izteiksmi.

Īpašības darbība:
- tikai lasāms
formula string Lietotāja definēta izteiksme, kas jāizmanto filtru ar pielāgotu izteiksmi nosacījumu novērtēšanai. Izteiksmē jābūt ID, kas atsaucas uz konkrētiem filtra nosacījumiem, izmantojot to formulaid. Izteiksmē izmantotajiem ID ir precīzi jāatbilst filtra nosacījumos definētajiem ID: neviens nosacījums nedrīkst palikt neizmantots vai izlaists.

Īpašības darbība:
- obligāts, ja evaltype ir iestatīts uz “Pielāgota izteiksme”
Telemetrijas datu filtra nosacījumi

Telemetrijas datu filtra nosacījumu objektam ir šādas īpašības.

Property Type Description
column string Telemetrijas datu kolonnas nosaukums, uz kuru attiecas filtra nosacījums.
Skatiet atbalstītās telemetrijas datu kolonnas.

Property behavior:
- required
attribute_key string Atslēgas nosaukums, uz kuru attiecas nosacījums, kolonnā, kurā ir atslēgu un vērtību pāri.

Property behavior:
- required if column is set to a column that holds key-value pairs
operator integer Filtra nosacījuma operators.

Iespējamās vērtības kolonnām ar vienu vērtību:
0 - Vienāds;
1 - Nav vienāds;
2 - Satur;
3 - Nesatur.

Iespējamās vērtības kolonnām, kurās ir atslēgu un vērtību pāri:
0 - Vienāds;
1 - Nav vienāds;
12 - Pastāv.

Property behavior:
- required
value string Vērtība, ar kuru salīdzināt.

Property behavior:
- required if operator is set to "Equals", "Does not equal", "Contains" or "Does not contain"
formulaid string Patvaļīgs unikāls ID, kas tiek izmantots, lai atsauktos uz nosacījumu no pielāgotas izteiksmes. Tajā var būt tikai lielie burti. ID lietotājam ir jādefinē, modificējot filtra nosacījumus, taču, tos vēlāk pieprasot, tas tiks ģenerēts no jauna.

Property behavior:
- required if evaltype of Telemetry query filter object is set to "Custom expression"

Vienuma tags

Vienuma taga objektam ir šādas īpašības.

Īpašība Tips Apraksts
tag string Vienuma taga nosaukums.

Īpašības darbība:
- obligāts
value string Vienuma taga vērtība.

Īpašības darbība:
- tikai lasāms.
object integer Objekta tips, no kura tags tika mantots.

Iespējamās vērtības:
0 - veidne;
1 - hosts.

Īpašības darbība:
- tikai lasāms.
objectid ID Objekta ID, no kura tags tika mantots.

Īpašības darbība:
- tikai lasāms.

Vienuma priekšapstrāde

Vienuma priekšapstrādes objektam ir šādi rekvizīti.

Rekvizīts Tips Apraksts
type integer Priekšapstrādes opcijas tips.

Iespējamās vērtības:
1 - Pielāgots reizinātājs;
2 - Labās puses atstarpju un rakstzīmju noņemšana;
3 - Kreisās puses atstarpju un rakstzīmju noņemšana;
4 - Atstarpju un rakstzīmju noņemšana;
5 - Regulārā izteiksme;
6 - Būla vērtības pārveidošana decimālskaitlī;
7 - Oktālā skaitļa pārveidošana decimālskaitlī;
8 - Heksadecimālā skaitļa pārveidošana decimālskaitlī;
9 - Vienkāršas izmaiņas;
10 - Izmaiņas sekundē;
11 - XML XPath;
12 - JSONPath;
13 - Diapazonā;
14 - Atbilst regulārajai izteiksmei;
15 - Neatbilst regulārajai izteiksmei;
16 - JSON kļūdas pārbaude;
17 - XML kļūdas pārbaude;
18 - Kļūdas pārbaude, izmantojot regulāro izteiksmi;
19 - Nemainītu vērtību atmešana;
20 - Nemainītu vērtību atmešana ar sirdspukstu;
21 - JavaScript;
22 - Prometheus raksts;
23 - Prometheus pārveidošana JSON formātā;
24 - CSV pārveidošana JSON formātā;
25 - Aizstāšana;
26 - Neatbalstīta vienuma pārbaude;
27 - XML pārveidošana JSON formātā;
28 - SNMP walk vērtība;
29 - SNMP walk pārveidošana JSON formātā;
30 - SNMP get vērtība.

Rekvizīta darbība:
- obligāts
params string Papildu parametri, ko izmanto priekšapstrādes opcija.
Vairāki parametri tiek atdalīti ar jaunas rindas (\n) rakstzīmi.

Ja type ir iestatīts uz "Neatbalstīta vienuma pārbaude", parametri atbilst sintaksei <scope>[\n<pattern>], kur pattern ir regulārā izteiksme, bet scope ir viena no šīm vērtībām:
-1 - atbilst jebkurai kļūdai;
\ 0 - pārbaudīt, vai kļūdas ziņojums atbilst pattern;
\ 1 - pārbaudīt, vai kļūdas ziņojums neatbilst pattern.

Rekvizīta darbība:
- obligāts, ja type ir iestatīts uz "Pielāgots reizinātājs" (1), "Labās puses atstarpju un rakstzīmju noņemšana" (2), "Kreisās puses atstarpju un rakstzīmju noņemšana" (3), "Atstarpju un rakstzīmju noņemšana" (4), "Regulārā izteiksme" (5), "XML XPath" (11), "JSONPath" (12), "Diapazonā" (13), "Atbilst regulārajai izteiksmei" (14), "Neatbilst regulārajai izteiksmei" (15), "JSON kļūdas pārbaude" (16), "XML kļūdas pārbaude" (17), "Kļūdas pārbaude, izmantojot regulāro izteiksmi" (18), "Nemainītu vērtību atmešana ar sirdspukstu" (20), "JavaScript" (21), "Prometheus raksts" (22), "Prometheus pārveidošana JSON formātā" (23), "CSV pārveidošana JSON formātā" (24), "Aizstāšana" (25), Neatbalstīta vienuma pārbaude (26), "SNMP walk vērtība" (28), "SNMP walk pārveidošana JSON formātā" (29) vai "SNMP get vērtība" (30)
error_handler integer Darbības tips, ko izmanto priekšapstrādes soļa kļūmes gadījumā.

Iespējamās vērtības:
0 - Kļūdas ziņojumu iestata Zabbix serveris;
1 - Atmest vērtību;
2 - Iestatīt pielāgotu vērtību;
3 - Iestatīt pielāgotu kļūdas ziņojumu.

Iespējamās vērtības, ja type ir iestatīts uz "Neatbalstīta vienuma pārbaude":
1 - Atmest vērtību;
2 - Iestatīt pielāgotu vērtību;
3 - Iestatīt pielāgotu kļūdas ziņojumu.

Rekvizīta darbība:
- obligāts, ja type ir iestatīts uz "Pielāgots reizinātājs" (1), "Regulārā izteiksme" (5), "Būla vērtības pārveidošana decimālskaitlī" (6), "Oktālā skaitļa pārveidošana decimālskaitlī" (7), "Heksadecimālā skaitļa pārveidošana decimālskaitlī" (8), "Vienkāršas izmaiņas" (9), "Izmaiņas sekundē" (10), "XML XPath" (11), "JSONPath" (12), "Diapazonā" (13), "Atbilst regulārajai izteiksmei" (14), "Neatbilst regulārajai izteiksmei" (15), "JSON kļūdas pārbaude" (16), "XML kļūdas pārbaude" (17), "Kļūdas pārbaude, izmantojot regulāro izteiksmi" (18), "Prometheus raksts" (22), "Prometheus pārveidošana JSON formātā" (23), "CSV pārveidošana JSON formātā" (24), "Neatbalstīta vienuma pārbaude" (26), "XML pārveidošana JSON formātā" (27), "SNMP walk vērtība" (28), "SNMP walk pārveidošana JSON formātā" (29) vai "SNMP get vērtība" (30)
error_handler_params string Kļūdu apstrādes parametri.

Rekvizīta darbība:
- obligāts, ja error_handler ir iestatīts uz "Iestatīt pielāgotu vērtību" vai "Iestatīt pielāgotu kļūdas ziņojumu"

Tālāk norādītie parametri un kļūdu apstrādes veidi tiek atbalstīti katram priekšapstrādes tipam.

Priekšapstrādes tips Nosaukums 1. parametrs 2. parametrs 3. parametrs Atbalstītie kļūdu apstrādes veidi
1 Pielāgots reizinātājs number1, 6 0, 1, 2, 3
2 Labās puses atstarpju un rakstzīmju noņemšana rakstzīmju saraksts2
3 Kreisās puses atstarpju un rakstzīmju noņemšana rakstzīmju saraksts2
4 Atstarpju un rakstzīmju noņemšana rakstzīmju saraksts2
5 Regulārā izteiksme pattern3 output2 0, 1, 2, 3
6 Būla vērtības pārveidošana decimālskaitlī 0, 1, 2, 3
7 Oktālā skaitļa pārveidošana decimālskaitlī 0, 1, 2, 3
8 Heksadecimālā skaitļa pārveidošana decimālskaitlī 0, 1, 2, 3
9 Vienkāršas izmaiņas 0, 1, 2, 3
10 Izmaiņas sekundē 0, 1, 2, 3
11 XML XPath path4 0, 1, 2, 3
12 JSONPath path4 0, 1, 2, 3
13 Diapazonā min1, 6 max1, 6 0, 1, 2, 3
14 Atbilst regulārajai izteiksmei pattern3 0, 1, 2, 3
15 Neatbilst regulārajai izteiksmei pattern3 0, 1, 2, 3
16 JSON kļūdas pārbaude path4 0, 1, 2, 3
17 XML kļūdas pārbaude path4 0, 1, 2, 3
18 Kļūdas pārbaude, izmantojot regulāro izteiksmi pattern3 output2 0, 1, 2, 3
19 Nemainītu vērtību atmešana
20 Nemainītu vērtību atmešana ar sirdspukstu seconds5, 6
21 JavaScript script2
22 Prometheus raksts pattern6, 7 value, label, function output8, 9 0, 1, 2, 3
23 Prometheus pārveidošana JSON formātā pattern6, 7 0, 1, 2, 3
24 CSV pārveidošana JSON formātā character2 character2 0,1 0, 1, 2, 3
25 Aizstāšana search string2 replacement2
26 Neatbalstīta vienuma pārbaude scope1 pattern3, 6 1, 2, 3
27 XML pārveidošana JSON formātā 0, 1, 2, 3
28 SNMP walk vērtība OID2 Formāts:
0 - Nemainīts
1 - UTF-8 no Hex-STRING
2 - MAC no Hex-STRING
3 - Integer no BITS		 0, 1, 2, 3
29 SNMP walk pārveidošana JSON formātā10 Field name2 OID prefix2 Formāts:
0 - Nemainīts
1 - UTF-8 no Hex-STRING
2 - MAC no Hex-STRING
3 - Integer no BITS		 0, 1, 2, 3
30 SNMP get vērtība Formāts:
1 - UTF-8 no Hex-STRING
2 - MAC no Hex-STRING
3 - Integer no BITS		 0, 1, 2, 3

1 peldošā komata skaitlis (veseli skaitļi tiek netieši pārveidoti par peldošā komata vērtībām)
2 virkne
3 regulārā izteiksme
4 JSONPath vai XML XPath
5 pozitīvs vesels skaitlis (ar laika sufiksu atbalstu, piemēram, 30s, 1m, 2h, 1d)
6 lietotāja makross
7 Prometheus raksts ar šādu sintaksi: <metric name>{<label name>="<label value>", ...} == <value>. Katrs Prometheus raksta komponents (metrika, etiķetes nosaukums, etiķetes vērtība un metrikas vērtība) var būt lietotāja makross.
8 Prometheus izvade ar šādu sintaksi: <label name> (var būt lietotāja makross), ja kā otrais parametrs ir atlasīts label.
9 Viena no apkopošanas funkcijām: sum, min, max, avg, count, ja kā otrais parametrs ir atlasīts function.
10 Atbalsta vairākus "Field name,OID prefix,Format records" ierakstus, kas atdalīti ar jaunas rindas rakstzīmi.