Vienuma prototipa objekts

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

Vienuma prototips

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

Property Type Description
itemid ID Vienuma prototipa ID.

Property behavior:
- read-only
- required for update operations
delay string Vienuma prototipa 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 custom intervals, visus atdalītus ar semikoliem. Pielāgotie intervāli var būt elastīgo un plānošanas intervālu kombinācija.

Pieņem lietotāja makro un LLD makro. Ja tiek izmantots, vērtībai jābūt vienam makro. Vairāki makro vai makro, kas sajaukti 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 ID, kuram pieder vienuma prototips.

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

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

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

Property behavior:
- required for create operations
- read-only for inherited objects
type integer Vienuma prototipa 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);
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
url string URL virkne.
Atbalsta LLD makro, lietotāja makro, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}.

Property behavior:
- required if type is set to "HTTP agent"
- read-only for inherited objects
value_type integer Vienuma prototipa informācijas tips.

Iespējamās vērtības:
0 - numeric float;
1 - character;
2 - log;
3 - numeric unsigned;
4 - text;
5 - binary;
6 - JSON.

Property behavior:
- required for create operations
- read-only for inherited objects
allow_traps integer Atļaut vērtības aizpildīšanu līdzīgi kā 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"
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")
description string Vienuma prototipa apraksts.
flags integer Vienuma prototipa izcelsme.

Iespējamās vērtības:
2 - vienuma prototips;
6 - atklāts vienuma prototips

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
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
history string Laika vienība, kas nosaka, cik ilgi jāglabā vēstures dati.
Pieņem arī lietotāja makro un LLD makro.

Noklusējums: 31d.
http_proxy string HTTP(S) starpniekservera savienojuma virkne.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited 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
jmx_endpoint string JMX aģenta pielāgota savienojuma virkne.

Noklusējums: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi

Property behavior:
- supported if type is set to "JMX agent"
logtimefmt string Laika formāts žurnāla ierakstos.

Property behavior:
- supported if value_type is set to "log"
- read-only for inherited objects
master_itemid ID Galvenā vienuma ID.

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

Iespējamās vērtības:
0 - (default) Saglabāt neapstrādātus datus;
1 - Konvertēt uz JSON.

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

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")
parameters object/array Papildu parametri, ja type ir iestatīts uz "Script" vai "Browser". Objektu masīvs ar name un value īpašībām, kur name jābūt unikālam.

Property behavior:
- supported if type is set to "Script" or "Browser"
- read-only for inherited 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")
post_type integer Ziņojuma datu pamatnes tips, kas glabājas 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
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
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"
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"
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
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
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
snmp_oid string SNMP OID.

Property behavior:
- required if type is set to "SNMP agent"
- read-only for inherited 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
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
ssl_key_password string Parole SSL atslēgas failam.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects
status integer Vienuma prototipa statuss.

Iespējamās vērtības:
0 - (default) iespējots vienuma prototips;
1 - atspējots vienuma prototips;
3 - neatbalstīts vienuma prototips.
status_codes string Nepieciešamo HTTP statusa kodu diapazoni, atdalīti ar komatiem.
Atbalsta arī lietotāja makro vai LLD 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
templateid ID Vecākveidnes vienuma prototipa ID.

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 un LLD 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 objects
trapper_hosts string Atļautie hosts.

Property behavior:
- 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".
If the property is omitted, it is automatically set to the {$TRAPPER.ALLOWED_HOSTS} user macro (default value). By default, {$TRAPPER.ALLOWED_HOSTS} is 127.0.0.1,::1.
If the property is set to an empty string, incoming connections will be denied from all hosts.
trends string Laika vienība, kas nosaka, cik ilgi jāglabā tendenču dati.
Pieņem arī lietotāja makro un LLD makro.

Noklusējums: 365d.

Property behavior:
- supported if value_type is set to "numeric float" or "numeric unsigned"
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
username string Autentifikācijas lietotājvārds.

Property behavior:
- required if type is set to "SSH agent" or "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")
uuid string Universāls unikāls identifikators, ko izmanto importēto vienuma prototipu sasaistīšanai ar jau esošajiem. Tiek ģenerēts automātiski, ja nav norādīts.

Property behavior:
- supported if the item prototype 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
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
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
discover integer Vienuma prototipa atklāšanas statuss.

Iespējamās vērtības:
0 - (default) tiks atklāti jauni vienumi;
1 - jauni vienumi netiks atklāti, un esošie vienumi tiks atzīmēti kā pazaudēti.

HTTP galvene

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

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

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

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

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āts
value string Parametra vērtība.

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

Vienuma prototipa tags

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

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

Īpašības darbība:
- obligāts
value string Vienuma prototipa 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 prototipa priekšapstrāde

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

Īpašība Tips Apraksts
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ība uz decimāldaļu;
7 - Oktāls uz decimāldaļu;
8 - Heksadecimāls uz decimāldaļu;
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 - 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, ja nav izmaiņu;
20 - Atmest, ja nav izmaiņu, ar sirdspukstu;
21 - JavaScript;
22 - Prometheus modelis;
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.

Īpašības darbība:
- obligāta
params string Papildu parametri, ko izmanto priekšapstrādes opcija.
Vairāki parametri ir atdalīti ar jaunās rindas (\n) rakstzīmi.

Ja type ir iestatīts uz "Pārbaudīt neatbalstītu", parametri izmanto sintaksi <scope>[\n<pattern>], kur pattern ir regulārā izteiksme, un scope ir viens no šiem:
-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.

Īpašības darbība:
- obligāta, ja type ir iestatīts uz "Pielāgots reizinātājs" (1), "Apgriezt no labās puses" (2), "Apgriezt no kreisās puses" (3), "Apgriezt" (4), "Regulārā izteiksme" (5), "XML XPath" (11), "JSONPath" (12), "Diapazonā" (13), "Atbilst regulārajai izteiksmei" (14), "Neatbilst regulārajai izteiksmei" (15), "Pārbaudīt kļūdu JSON" (16), "Pārbaudīt kļūdu XML" (17), "Pārbaudīt kļūdu, izmantojot regulāro izteiksmi" (18), "Atmest, ja nav izmaiņu, ar sirdspukstu" (20), "JavaScript" (21), "Prometheus modelis" (22), "Prometheus uz JSON" (23), "CSV uz JSON" (24), "Aizstāt" (25), "Pārbaudīt neatbalstītu" (26), "SNMP walk vērtība" (28), "SNMP walk uz JSON" (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 "Pārbaudīt neatbalstītu":
1 - Atmest vērtību;
2 - Iestatīt pielāgotu vērtību;
3 - Iestatīt pielāgotu kļūdas ziņojumu.

Īpašības darbība:
- obligāta, ja type ir iestatīts uz "Pielāgots reizinātājs" (1), "Regulārā izteiksme" (5), "Būla vērtība uz decimāldaļu" (6), "Oktāls uz decimāldaļu" (7), "Heksadecimāls uz decimāldaļu" (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), "Pārbaudīt kļūdu JSON" (16), "Pārbaudīt kļūdu XML" (17), "Pārbaudīt kļūdu, izmantojot regulāro izteiksmi" (18), "Prometheus modelis" (22), "Prometheus uz JSON" (23), "CSV uz JSON" (24), "Pārbaudīt neatbalstītu" (26), "XML uz JSON" (27), "SNMP walk vērtība" (28), "SNMP walk uz JSON" (29) vai "SNMP get vērtība" (30)
error_handler_params string Kļūdu apstrādātāja parametri.

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

Katram priekšapstrādes tipam tiek atbalstīti šādi parametri un kļūdu apstrādātāji.

Priekšapstrādes tips Nosaukums 1. parametrs 2. parametrs 3. parametrs Atbalstītie kļūdu apstrādātāji
1 Pielāgots reizinātājs skaitlis1, 6 0, 1, 2, 3
2 Apgriezt no labās puses rakstzīmju saraksts2
3 Apgriezt no kreisās puses rakstzīmju saraksts2
4 Apgriezt rakstzīmju saraksts2
5 Regulārā izteiksme modelis3 izvade2 0, 1, 2, 3
6 Būla vērtība uz decimāldaļu 0, 1, 2, 3
7 Oktāls uz decimāldaļu 0, 1, 2, 3
8 Heksadecimāls uz decimāldaļu 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 ceļš4 0, 1, 2, 3
12 JSONPath ceļš4 0, 1, 2, 3
13 Diapazonā min1, 6 max1, 6 0, 1, 2, 3
14 Atbilst regulārajai izteiksmei modelis3 0, 1, 2, 3
15 Neatbilst regulārajai izteiksmei modelis3 0, 1, 2, 3
16 Pārbaudīt kļūdu JSON ceļš4 0, 1, 2, 3
17 Pārbaudīt kļūdu XML ceļš4 0, 1, 2, 3
18 Pārbaudīt kļūdu, izmantojot regulāro izteiksmi modelis3 izvade2 0, 1, 2, 3
19 Atmest, ja nav izmaiņu
20 Atmest, ja nav izmaiņu, ar sirdspukstu sekundes5, 6
21 JavaScript skripts2
22 Prometheus modelis modelis6, 7 value, label, function izvade8, 9 0, 1, 2, 3
23 Prometheus uz JSON modelis6, 7 0, 1, 2, 3
24 CSV uz JSON rakstzīme2 rakstzīme2 0,1 0, 1, 2, 3
25 Aizstāt meklējamā virkne2 aizstāšana2
26 Pārbaudīt neatbalstītu tvērums1 modelis3, 6 1, 2, 3
27 XML uz JSON 0, 1, 2, 3
28 SNMP walk vērtība OID2 Formāts:
0 - Bez izmaiņām
1 - UTF-8 no Hex-STRING
2 - MAC no Hex-STRING
3 - Vesels skaitlis no BITS		 0, 1, 2, 3
29 SNMP walk uz JSON10 Lauka nosaukums2 OID prefikss2 Formāts:
0 - Bez izmaiņām
1 - UTF-8 no Hex-STRING
2 - MAC no Hex-STRING
3 - Vesels skaitlis 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 - Vesels skaitlis no BITS		 0, 1, 2, 3

1 vesels skaitlis vai peldošā komata skaitlis
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, LLD makross
7 Prometheus modelis, kas atbilst sintaksei: <metric name>{<label name>="<label value>", ...} == <value>. Katrs Prometheus modeļa komponents (metrika, etiķetes nosaukums, etiķetes vērtība un metrikas vērtība) var būt lietotāja makross vai LLD makross.
8 Prometheus izvade, kas atbilst sintaksei: <label name> (var būt lietotāja makross vai LLD makross), 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 "Lauka nosaukums,OID prefikss,Formāts ierakstus", kas atdalīti ar jaunās rindas rakstzīmi.