Vienuma prototipa objekts

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

Vienuma prototips

Vienuma prototipa objektam ir šādi rekvizīti.

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 pielāgotos intervālus, 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 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 aģents" (0), "Simple check" (3), "Zabbix internal" (5), "External check" (10), "Database monitor" (11), "IPMI aģents" (12), "SSH aģents" (13), "TELNET aģents" (14), "Calculated" (15), "JMX aģents" (16), "HTTP aģents" (19), "SNMP aģents" (20), "Script" (21), "Browser" (22), or if type is set to "Zabbix aģents (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 aģents", "IPMI aģents", "JMX aģents", "SNMP trap", or "SNMP aģents"
- supported if item prototype belongs to host and type is set to "Simple check", "External check", "SSH aģents", "TELNET aģents", or "HTTP aģents"
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 aģents"
- 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.

Property behavior:
- required for create operations
- read-only for inherited objects
allow_traps integer Atļaut aizpildīt vērtību 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 aģents"
authtype integer Autentifikācijas metode.

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

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

Property behavior:
- supported if type is set to "SSH aģents" or "HTTP aģents"
- read-only for inherited objects (if type is set to "HTTP aģents")
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 aģents"
- 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 aģents"
- read-only for inherited objects
history string Laika vienība, cik ilgi jāglabā vēstures dati.
Pieņem arī lietotāja makro un LLD makro.

Default: 31d.
http_proxy string HTTP(S) starpniekservera savienojuma virkne.

Property behavior:
- supported if type is set to "HTTP aģents"
- read-only for inherited objects
ipmi_sensor string IPMI sensors.

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

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

Property behavior:
- supported if type is set to "JMX aģents"
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 atbildi vajadzētu konvertēt uz JSON.

Iespējamās vērtības:
0 - (default) Store raw;
1 - Convert to JSON.

Property behavior:
- supported if type is set to "HTTP aģents"
- 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 database monitor vienuma prototipiem;
- formula calculated vienuma prototipiem;
- skripts script un browser vienuma prototipiem.

Property behavior:
- required if type is set to "Database monitor", "SSH aģents", "TELNET aģents", "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 rekvizītiem, 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 aģents" and username is set
- supported if type is set to "Simple check", "SSH aģents", "TELNET aģents", "Database monitor", or "HTTP aģents"
- read-only for inherited objects (if type is set to "HTTP aģents")
post_type integer Ziņojuma datu pamatteksta tips, kas glabājas posts rekvizītā.

Iespējamās vērtības:
0 - (default) Raw data.
2 - JSON data.
3 - XML data.

Property behavior:
- supported if type is set to "HTTP aģents"
- read-only for inherited objects
posts string HTTP(S) pieprasījuma pamatteksta dati.

Property behavior:
- required if type is set to "HTTP aģents" and post_type is set to "JSON data" or "XML data"
- supported if type is set to "HTTP aģents" 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 aģents" and authtype is set to "public key"
publickey string Publiskās atslēgas faila nosaukums.

Property behavior:
- required if type is set to "SSH aģents" 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 aģents"
- 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 aģents"
- 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) Body;
1 - Headers;
2 - Tiks glabāts gan pamatteksts, gan galvenes.

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

Property behavior:
- supported if type is set to "HTTP aģents"
- read-only for inherited objects
snmp_oid string SNMP OID.

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

Property behavior:
- supported if type is set to "HTTP aģents"
- 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 aģents"
- 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.

Default: "" - izmantot starpniekservera/globalos iestatījumus.

Property behavior:
- supported if type is set to "Zabbix aģents" (0), "Simple check" (3) and key_ does not start with "vmware." and "icmpping", "Zabbix aģents (active)" (7), "External check" (10), "Database monitor" (11), "SSH aģents" (13), "TELNET aģents" (14), "HTTP aģents" (19), "SNMP aģents" (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 aģents" 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 un LLD makro.

Default: 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 Lietotājvārds autentifikācijai.

Property behavior:
- required if type is set to "SSH aģents" or "TELNET aģents", or if type is set to "JMX aģents" and password is set
- supported if type is set to "Simple check", "Database monitor", or "HTTP aģents"
- read-only for inherited objects (if type is set to "HTTP aģents")
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 ir 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 aģents"
- 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 aģents"
- 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ā pazuduši.

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.

Property Type Description
tag string Vienuma prototipa taga nosaukums.

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

Vienuma prototipa priekšapstrāde

Vienuma prototipa 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ība uz decimāldaļu;
7 - Oktāldaļskaitlis uz decimāldaļu;
8 - Heksadecimāls uz decimāldaļu;
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ītu;
20 - Atmest nemainītu ar sirdspukstu;
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ītajiem priekšapstrādes tipiem tiek atbalstīti šādi parametri un kļūdu apstrādātāji.

Preprocessing type Name Parameter 1 Parameter 2 Parameter 3 Supported error handlers
1 Custom multiplier number1, 6 0, 1, 2, 3
2 Right trim list of characters2
3 Left trim list of characters2
4 Trim list of characters2
5 Regular expression pattern3 output2 0, 1, 2, 3
6 Boolean to decimal 0, 1, 2, 3
7 Octal to decimal 0, 1, 2, 3
8 Hexadecimal to decimal 0, 1, 2, 3
9 Simple change 0, 1, 2, 3
10 Change per second 0, 1, 2, 3
11 XML XPath path4 0, 1, 2, 3
12 JSONPath path4 0, 1, 2, 3
13 In range min1, 6 max1, 6 0, 1, 2, 3
14 Matches regular expression pattern3 0, 1, 2, 3
15 Does not match regular expression pattern3 0, 1, 2, 3
16 Check for error in JSON path4 0, 1, 2, 3
17 Check for error in XML path4 0, 1, 2, 3
18 Check for error using regular expression pattern3 output2 0, 1, 2, 3
19 Discard unchanged
20 Discard unchanged with heartbeat seconds5, 6
21 JavaScript script2
22 Prometheus pattern pattern6, 7 value, label, function output8, 9 0, 1, 2, 3
23 Prometheus to JSON pattern6, 7 0, 1, 2, 3
24 CSV to JSON character2 character2 0,1 0, 1, 2, 3
25 Replace search string2 replacement2
26 Check unsupported scope1 pattern3, 6 1, 2, 3
27 XML to JSON 0, 1, 2, 3
28 SNMP walk value OID2 Format:
0 - Unchanged
1 - UTF-8 from Hex-STRING
2 - MAC from Hex-STRING
3 - Integer from BITS		 0, 1, 2, 3
29 SNMP walk to JSON10 Field name2 OID prefix2 Format:
0 - Unchanged
1 - UTF-8 from Hex-STRING
2 - MAC from Hex-STRING
3 - Integer from BITS		 0, 1, 2, 3
30 SNMP get value Format:
1 - UTF-8 from Hex-STRING
2 - MAC from Hex-STRING
3 - Integer from BITS		 0, 1, 2, 3

1 vesels 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 makro, LLD makro
7 Prometheus pattern atbilstoši sintaksei: <metric name>{<label name>="<label value>", ...} == <value>. Katru Prometheus pattern komponenti (metrika, etiķetes nosaukums, etiķetes vērtība un metrikas vērtība) var būt lietotāja makro vai LLD makro.
8 Prometheus izvade atbilstoši sintaksei: <label name> (var būt lietotāja makro vai LLD makro), ja label ir atlasīts kā otrais parametrs.
9 Viena no agregācijas funkcijām: sum, min, max, avg, count, ja function ir atlasīts kā otrais parametrs.
10 Atbalsta vairākus "Field name,OID prefix,Format records" ierakstus, kas atdalīti ar jaunas rindas rakstzīmi.