Vienuma objekts

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

Vienums

Web vienumus nevar tieši izveidot, atjaunināt vai dzēst, izmantojot Zabbix API.

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

Property Type Description
itemid ID Vienuma ID.

Property behavior:
- read-only
- required for update operations
delay string Vienuma atjaunināšanas intervāls.

Pieņem sekundes vai laika vienību ar sufiksu (piem., 30s, 1m, 2h, 1d) un, pēc izvēles, vienu vai vairākus pielāgotos intervālus, visus atdalot ar semikoliem. Pielāgotie intervāli var būt elastīgo un plānotu intervālu kombinācija.

Pieņem lietotāja makro. Ja tiek izmantots, vērtībai jābūt vienam makro. Vairāki makro vai makro kopā ar tekstu netiek atbalstīti. Elastīgos intervālus var rakstīt kā divus makro, kas atdalīti ar slīpsvītru (piem., {$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}

Property behavior:
- required if type is set to "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), or if type is set to "Zabbix agent (active)" (7) and key_ does not contain "mqtt.get"
hostid ID Hosta vai veidnes ID, kurai pieder vienums.

Property behavior:
- constant
- required for create operations
interfaceid ID Vienuma hosta saskarnes ID.

Property behavior:
- required if item belongs to host and type is set to "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap", or "SNMP agent"
- supported if item belongs to host and type is set to "Simple check", "External check", "SSH agent", "TELNET agent", or "HTTP agent"
- read-only for discovered objects
key_ string Vienuma atslēga.

Property behavior:
- required for create operations
- read-only for inherited objects or discovered objects
name string Vienuma nosaukums.
Atbalsta lietotāja makro.

Property behavior:
- required for create operations
- read-only for inherited objects or discovered objects
name_resolved string Vienuma nosaukums ar atrisinātiem lietotāja makro.

Property behavior:
- read-only
type integer Vienuma tips.

Iespējamās vērtības:
0 - Zabbix aģents;
2 - Zabbix trapper;
3 - Simple check;
5 - Zabbix internal;
7 - Zabbix aģents (active);
9 - Web vienums;
10 - External check;
11 - Database monitor;
12 - IPMI aģents;
13 - SSH aģents;
14 - TELNET aģents;
15 - Calculated;
16 - JMX aģents;
17 - SNMP trap;
18 - Dependent item;
19 - HTTP aģents;
20 - SNMP aģents;
21 - Script;
22 - Browser.

Property behavior:
- required for create operations
- read-only for inherited objects or discovered objects
url string URL virkne.
Atbalsta lietotāja makro, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}.

Property behavior:
- required if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
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 - neparakstīts skaitlis;
4 - teksts;
5 - binārs.

Property behavior:
- required for create operations
- read-only for inherited objects or discovered objects
allow_traps integer Atļaut vērtības aizpildīšanu līdzīgi trapper vienumam.

0 - (default) Neatļaut pieņemt ienākošos datus;
1 - Atļaut pieņemt ienākošos datus.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for discovered objects
authtype integer Autentifikācijas metode.

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

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

Property behavior:
- supported if type is set to "SSH agent" or "HTTP agent"
- read-only for inherited objects (if type is set to "HTTP agent") or discovered objects
description string Vienuma apraksts.

Property behavior:
- read-only for discovered objects
error string Kļūdas teksts, ja rodas problēmas ar vienuma vērtības atjaunināšanu.

Property behavior:
- read-only
flags integer Vienuma izcelsme.

Iespējamās vērtības:
0 - parasts vienums;
4 - atklāts vienums.

Property behavior:
- read-only
follow_redirects integer Sekot atbildes pāradresācijām datu aptaujas laikā.

Iespējamās vērtības:
0 - nesekot pāradresācijām;
1 - (default) sekot pāradresācijām.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
headers array Galveņu masīvs, kas tiks nosūtīts, veicot HTTP pieprasījumu.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
history string Laika vienība, cik ilgi jāglabā vēstures dati.
Pieņem arī lietotāja makro.

Noklusējums: 31d.

Property behavior:
- read-only for discovered objects
http_proxy string HTTP(S) starpniekservera savienojuma virkne.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
inventory_link integer Hosta inventāra lauka ID, ko aizpilda vienums.

Skatiet hosta inventāra lapu, lai iegūtu atbalstīto hosta inventāra lauku un to ID sarakstu.

Noklusējums: 0.

Property behavior:
- supported if value_type is set to "numeric float", "character", "numeric unsigned", or "text"
- read-only for discovered objects
ipmi_sensor string IPMI sensors.

Property behavior:
- required if type is set to "IPMI agent" and key_ is not set to "ipmi.get"
- supported if type is set to "IPMI agent"
- read-only for inherited objects or discovered objects
jmx_endpoint string JMX aģenta pielāgota savienojuma virkne.

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

Property behavior:
- supported if type is set to "JMX agent"
- read-only for discovered objects
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ējās 24 stundās. Šo laika periodu var pagarināt, mainot Max history display period parametra vērtību izvēlnes sadaļā Administration → General.

Property behavior:
- read-only
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ējās 24 stundās. Šo laika periodu var pagarināt, mainot Max history display period parametra vērtību izvēlnes sadaļā Administration → General.

Property behavior:
- read-only
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ējās 24 stundās. Šo laika periodu var pagarināt, mainot Max history display period parametra vērtību izvēlnes sadaļā Administration → General.

Property behavior:
- read-only
logtimefmt string Laika formāts žurnāla ierakstos.

Property behavior:
- supported if value_type is set to "log"
- read-only for inherited objects or discovered objects
master_itemid ID Galvenā vienuma ID.
Atļauta rekursija līdz 3 atkarīgajiem vienumiem, un maksimālais atkarīgo vienumu skaits ir 29999.

Property behavior:
- required if type is set to "Dependent item"
- read-only for inherited objects or discovered objects
output_format integer Vai atbilde jāpārveido uz JSON.

0 - (default) saglabāt neapstrādātu;
1 - pārveidot uz JSON.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
params string Papildu parametri atkarībā no vienuma tipa:
- izpildāms skripts SSH aģenta un TELNET aģenta vienumiem;
- SQL vaicājums datubāzes monitora vienumiem;
- formula aprēķinātajiem vienumiem;
- skripts skripta un pārlūka vienumiem.

Property behavior:
- required if type is set to "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script", or "Browser"
- read-only for inherited objects (if type is set to "Script" or "Browser") or discovered objects
parameters object/array Papildu parametri, ja type ir iestatīts uz "Script" vai "Browser". Objektu masīvs ar īpašībām name un value, kur name jābūt unikālam.

Property behavior:
- supported if type is set to "Script" or "Browser"
- read-only for inherited objects or discovered objects
password string Autentifikācijas parole.

Property behavior:
- required if type is set to "JMX agent" and username is set
- supported if type is set to "Simple check", "SSH agent", "TELNET agent", "Database monitor", or "HTTP agent"
- read-only for inherited objects (if type is set to "HTTP agent") or discovered objects
post_type integer Ziņojuma datu pamatnes tips, kas saglabāts posts īpašībā.

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

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
posts string HTTP(S) pieprasījuma pamatnes dati.

Property behavior:
- required if type is set to "HTTP agent" and post_type is set to "JSON data" or "XML data"
- supported if type is set to "HTTP agent" and post_type is set to "Raw data"
- read-only for inherited objects or discovered objects
prevvalue string Iepriekšējā vienuma vērtība.

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

Property behavior:
- read-only
privatekey string Privātās atslēgas faila nosaukums.

Property behavior:
- required if type is set to "SSH agent" and authtype is set to "public key"
- read-only for discovered objects
publickey string Publiskās atslēgas faila nosaukums.

Property behavior:
- required if type is set to "SSH agent" and authtype is set to "public key"
- read-only for discovered objects
query_fields array Vaicājuma lauku masīvs, kas tiks nosūtīts, veicot HTTP pieprasījumu.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
request_method integer Pieprasījuma metodes tips.

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

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
retrieve_mode integer Kura atbildes daļa jāglabā.

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

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

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
snmp_oid string SNMP OID.

Property behavior:
- required if type is set to "SNMP agent"
- read-only for inherited objects or discovered objects
ssl_cert_file string Publiskās SSL atslēgas faila ceļš.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
ssl_key_file string Privātās SSL atslēgas faila ceļš.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
ssl_key_password string Parole SSL atslēgas failam.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
state integer Vienuma stāvoklis.

Iespējamās vērtības:
0 - (default) normāls;
1 - neatbalstīts.

Property behavior:
- read-only
status integer Vienuma statuss.

Iespējamās vērtības:
0 - (default) 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ā komatiem atdalīta saraksta daļu.

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

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
templateid ID Vecākveidnes vienuma ID.

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

Property behavior:
- read-only
timeout string Vienuma datu aptaujas pieprasījuma noildze.
Pieņem sekundes vai laika vienību ar sufiksu (piem., 30s, 1m). Pieņem arī lietotāja makro.

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

Noklusējums: "" - izmantot starpniekservera/globalos iestatījumus.

Property behavior:
- supported if type is set to "Zabbix agent" (0), "Simple check" (3) and key_ does not start with "vmware." and "icmpping", "Zabbix agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH agent" (13), "TELNET agent" (14), "HTTP agent" (19), "SNMP agent" (20) and snmp_oid starts with "walk[" or "get[", "Script" (21), "Browser" (22)
- read-only for inherited and discovered objects
trapper_hosts string Atļautie hosts.

Property behavior:
- readonly for discovered objects
- supported if type is set to "Zabbix trapper", or if type is set to "HTTP agent" and allow_traps is set to "Allow to accept incoming data"
trends string Laika vienība, cik ilgi jāglabā tendenču dati.
Pieņem arī lietotāja makro.

Noklusējums: 365d.

Property behavior:
- supported if value_type is set to "numeric float" or "numeric unsigned"
- read-only for discovered objects
units string Vērtības vienības.

Property behavior:
- supported if value_type is set to "numeric float" or "numeric unsigned"
- read-only for inherited objects or discovered objects
username string Autentifikācijas lietotājvārds.

Property behavior:
- required if type is set to "SSH agent", "TELNET agent", or if type is set to "JMX agent" and password is set
- supported if type is set to "Simple check", "Database monitor", or "HTTP agent"
- read-only for inherited objects (if type is set to "HTTP agent") or discovered objects
uuid string Universāls unikāls identifikators, ko izmanto, lai importēto vienumu sasaistītu ar jau esošajiem. Tiek ģenerēts automātiski, ja nav norādīts.

Property behavior:
- supported if the item belongs to a template
valuemapid ID Saistītās vērtību kartes ID.

Property behavior:
- supported if value_type is set to "numeric float", "character", or "numeric unsigned"
- read-only for inherited objects or discovered objects
verify_host integer Vai pārbaudīt, ka savienojuma hosta nosaukums atbilst tam, kas norādīts hosta sertifikātā.

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

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
verify_peer integer Vai pārbaudīt, ka hosta sertifikāts ir autentisks.

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

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects

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

Vienuma tags

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

Property Type Description
tag string Vienuma taga nosaukums.

Property behavior:
- required
value string Vienuma taga vērtība.

Vienuma priekšapstrāde

Vienuma priekšapstrādes objektam ir šādas īpašības.

Property Type Description
type integer Priekšapstrādes opcijas tips.

Iespējamās vērtības:
1 - Pielāgots reizinātājs;
2 - Apgriezt no labās puses;
3 - Apgriezt no kreisās puses;
4 - Apgriezt;
5 - Regulārā izteiksme;
6 - Būla vērtību pārvērst decimāldaļā;
7 - Oktālo pārvērst decimāldaļā;
8 - Heksadecimālo pārvērst decimāldaļā;
9 - Vienkārša izmaiņa;
10 - Izmaiņa sekundē;
11 - XML XPath;
12 - JSONPath;
13 - Diapazonā;
14 - Atbilst regulārajai izteiksmei;
15 - Neatbilst regulārajai izteiksmei;
16 - Pārbaudīt kļūdu JSON;
17 - Pārbaudīt kļūdu XML;
18 - Pārbaudīt kļūdu, izmantojot regulāro izteiksmi;
19 - Atmest nemainīto;
20 - Atmest nemainīto ar heartbeat;
21 - JavaScript;
22 - Prometheus pattern;
23 - Prometheus uz JSON;
24 - CSV uz JSON;
25 - Aizstāt;
26 - Pārbaudīt neatbalstītu;
27 - XML uz JSON;
28 - SNMP walk vērtība;
29 - SNMP walk uz JSON;
30 - SNMP get vērtība.

Property behavior:
- required
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 "Check unsupported", parametriem ir <scope>[\n<pattern>] sintakse, 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.

Property behavior:
- required ja type ir iestatīts uz "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), vai "SNMP get value" (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 "Check unsupported":
1 - Atmest vērtību;
2 - Iestatīt pielāgotu vērtību;
3 - Iestatīt pielāgotu kļūdas ziņojumu.

Property behavior:
- required ja type ir iestatīts uz "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), vai "SNMP get value" (30)
error_handler_params string Kļūdu apstrādātāja parametri.

Property behavior:
- required ja error_handler ir iestatīts uz "Set custom value" vai "Set custom error message"

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

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 - Nemainīts
1 - UTF-8 no Hex-STRING
2 - MAC no Hex-STRING
3 - Vesels skaitlis no BITS		 0, 1, 2, 3
29 SNMP walk to JSON10 Field name2 OID prefix2 Format:
0 - Nemainīts
1 - UTF-8 no Hex-STRING
2 - MAC no Hex-STRING
3 - Vesels skaitlis no BITS		 0, 1, 2, 3
30 SNMP get value Format:
1 - UTF-8 no Hex-STRING
2 - MAC no Hex-STRING
3 - Vesels skaitlis no BITS		 0, 1, 2, 3

1 peldošā komata skaitlis (veselie 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 makro
7 Prometheus pattern atbilstoši sintaksei: <metric name>{<label name>="<label value>", ...} == <value>. Katrs Prometheus pattern komponents (metrikas nosaukums, etiķetes nosaukums, etiķetes vērtība un metrikas vērtība) var būt lietotāja makro.
8 Prometheus izvade atbilstoši sintaksei: <label name> (var būt lietotāja makro), ja kā otrais parametrs ir atlasīts label.
9 Viena no agregācijas 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.