Mediju tipa objekts

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

Medija tips

Medija tipa objektam ir šādas īpašības.

Property Type Description
mediatypeid ID Medija tipa ID.

Property behavior:
- tikai lasāms
- obligāts atjaunināšanas operācijām
name string Medija tipa nosaukums.

Property behavior:
- obligāts izveides operācijām
type integer Pārvades veids, ko izmanto medija tips.

Iespējamās vērtības:
0 - E-pasts;
1 - Skripts;
2 - SMS;
4 - Webhook.

Property behavior:
- obligāts izveides operācijām
exec_path string Skripta faila nosaukums (piemēram, notification.sh), kas atrodas direktorijā, kas norādīta serveris konfigurācijas parametrā AlertScriptsPath.

Property behavior:
- obligāts, ja type ir iestatīts uz "Script"
gsm_modem string GSM modema seriālās ierīces nosaukums.

Property behavior:
- obligāts, ja type ir iestatīts uz "SMS"
passwd string Autentifikācijas parole.

Property behavior:
- atbalstīts, ja smtp_authentication ir iestatīts uz "Normal password"
provider integer E-pasta pakalpojumu sniedzējs.

Iespējamās vērtības:
0 - (noklusējums) Generic SMTP;
1 - Gmail;
2 - Gmail relay;
3 - Office365;
4 - Office365 relay.
smtp_email string E-pasta adrese, no kuras tiks sūtīti paziņojumi.

Property behavior:
- obligāts, ja type ir iestatīts uz "Email"
smtp_helo string SMTP HELO.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Email"
smtp_server string SMTP serveris.

Property behavior:
- obligāts, ja type ir iestatīts uz "Email"
smtp_port integer SMTP servera ports, pie kura pieslēgties.

Noklusējums: 25.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Email"
smtp_security integer Izmantojamais SMTP savienojuma drošības līmenis.

Iespējamās vērtības:
0 - (noklusējums) Nav;
1 - STARTTLS;
2 - SSL/TLS.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Email"
smtp_verify_host integer SMTP SSL hosta verifikācija.

Iespējamās vērtības:
0 - (noklusējums) Nē;
1 - Jā.

Property behavior:
- atbalstīts, ja smtp_security ir iestatīts uz "STARTTLS" vai "SSL/TLS"
smtp_verify_peer integer SMTP SSL partnera verifikācija.

Iespējamās vērtības:
0 - (noklusējums) Nē;
1 - Jā.

Property behavior:
- atbalstīts, ja smtp_security ir iestatīts uz "STARTTLS" vai "SSL/TLS"
smtp_authentication integer Izmantojamā SMTP autentifikācijas metode.

Iespējamās vērtības:
0 - (noklusējums) Nav;
1 - Parastā parole;
2 - OAuth marķieris.
OAuth autentifikācija nav atļauta e-pasta pakalpojumu sniedzējam Office365 relay.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Email"
redirection_url string Zabbix lietotāja saskarne URL, uz kuru novirzīt atpakaļ OAuth autorizāciju.

Noklusējums:
API iestatījumu īpašības url vērtība ar daļu zabbix.php?action=oauth.authorize

Property behavior:
- obligāts, ja smtp_authentication ir iestatīts uz "OAuth token"
client_id string Klienta identifikators, kas reģistrēts OAuth autorizācijas serverī.

Property behavior:
- obligāts, ja smtp_authentication ir iestatīts uz "OAuth token"
client_secret string Klienta slepenā atslēga, kas reģistrēta OAuth autorizācijas serverī. Pieejama tikai lietotājam ar tipu Super Admin.

Property behavior:
- obligāts, ja smtp_authentication ir iestatīts uz "OAuth token"
authorization_url string OAuth URL ar parametriem, lai iegūtu piekļuves un atsvaidzināšanas marķierus.

Property behavior:
- obligāts, ja smtp_authentication ir iestatīts uz "OAuth token"
token_url string OAuth URL, lai apmainītu autorizācijas marķieri pret piekļuves un atsvaidzināšanas marķieriem.
Šo URL serveris arī izmanto, lai atsvaidzinātu nederīgu piekļuves marķieri.

Property behavior:
- obligāts, ja smtp_authentication ir iestatīts uz "OAuth token"
tokens_status integer Marķieru statusa bitu maska.

Iespējamās vērtības:
0 - (noklusējums) Abi marķieri satur nederīgu vērtību
1 - Piekļuves marķieris satur derīgu vērtību
2 - Atsvaidzināšanas marķieris satur derīgu vērtību
3 - Abi marķieri satur derīgu vērtību.

Property behavior:
- atbalstīts, ja smtp_authentication ir iestatīts uz "OAuth token"
access_token string OAuth piekļuves marķiera vērtība.

Property behavior:
- obligāts, ja smtp_authentication ir iestatīts uz "OAuth token"
access_token_updated timestamp Laika zīmogs pēdējai access_token izmaiņai, ko veicis serveris, atsvaidzinot ar refresh_token, vai API marķieru izmaiņu laikā.

Property behavior:
- atbalstīts, ja smtp_authentication ir iestatīts uz "OAuth token"
access_expires_in integer Laiks sekundēs, pēc kura access_token kļūs novecojis un būs jāveic pieprasījums uz refresh_url.
To iestata Zabbix serveris, atsvaidzinot access_token, vai API marķieru izmaiņu laikā.

Laika zīmogs tiek aprēķināts, pieskaitot access_token_updated vērtību.

Property behavior:
- atbalstīts, ja smtp_authentication ir iestatīts uz "OAuth token"
refresh_token string OAuth atsvaidzināšanas marķiera vērtība.

Property behavior:
- obligāts, ja smtp_authentication ir iestatīts uz "OAuth token"
status integer Vai medija tips ir iespējots.

Iespējamās vērtības:
0 - (noklusējums) Iespējots;
1 - Atspējots.
username string Lietotājvārds.

Property behavior:
- atbalstīts, ja smtp_authentication ir iestatīts uz "Normal password"
maxsessions integer Maksimālais brīdinājumu skaits, ko var apstrādāt paralēli.

Iespējamās vērtības, ja type ir iestatīts uz "SMS": 1.

Iespējamās vērtības, ja type ir iestatīts uz "Email", "Script" vai "Webhook": 0-100.

Noklusējums: 1.
maxattempts integer Maksimālais mēģinājumu skaits nosūtīt brīdinājumu.

Iespējamās vērtības: 1-100.

Noklusējums: 3.
attempt_interval string Intervāls starp atkārtotiem mēģinājumiem.
Pieņem sekundes un laika vienību ar sufiksu.

Iespējamās vērtības: 0-1h.

Noklusējums: 10s.
message_format integer Ziņojuma formāts.

Iespējamās vērtības:
0 - Vienkāršs teksts;
1 - (noklusējums) HTML.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Email"
script text Webhook skripta saturs (JavaScript).

Property behavior:
- obligāts, ja type ir iestatīts uz "Webhook"
timeout string Webhook skripta noildze.
Pieņem sekundes un laika vienību ar sufiksu.

Iespējamās vērtības: 1-60s.

Noklusējums: 30s.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Webhook"
process_tags integer Apstrādāt JSON īpašību vērtības Webhook skripta atbildē kā birkas. Šīs birkas tiek pievienotas visām esošajām problēmu birkām.

Iespējamās vērtības:
0 - (noklusējums) Ignorēt webhook skripta atbildi;
1 - Apstrādāt webhook skripta atbildi kā birkas.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Webhook"
show_event_menu integer Iekļaut ierakstu notikuma izvēlnē, kas norāda uz pielāgotu URL. Tas arī pievieno īpašību urls izvadei no problem.get un event.get.

Iespējamās vērtības:
0 - (noklusējums) Neiekļaut notikuma izvēlnes ierakstu vai īpašību urls;
1 - Iekļaut notikuma izvēlnes ierakstu un īpašību urls.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Webhook"
event_menu_url string URL, kas izmantots notikuma izvēlnes ierakstā un īpašībā urls, ko atgriež problem.get un event.get.

Property behavior:
- atbalstīts, ja show_event_menu ir iestatīts uz "Include event menu entry and urls property"
event_menu_name string Nosaukums, kas izmantots notikuma izvēlnes ierakstā un īpašībā urls, ko atgriež problem.get un event.get.

Property behavior:
- atbalstīts, ja show_event_menu ir iestatīts uz "Include event menu entry and urls property"
parameters array Webhook vai skripta parametri.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Webhook" vai "Script"
description text Medija tipa apraksts.

Webhook parametri

Webhook parametriem ir šādas īpašības.

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

Īpašības darbība:
- obligāts
value string Parametra vērtība, atbalsta makrosus.
Atbalstītie makrosi ir aprakstīti lapā Atbalstītie makrosi.

Skripta parametri

Skripta parametriem ir šādas īpašības.

Īpašība Tips Apraksts
sortorder integer Secība, kādā parametru vērtības tiks nodotas skriptam kā komandrindas argumenti, sākot ar 0 kā pirmo.

Īpašības darbība:
- obligāts
value string Parametra vērtība, atbalsta makrosus.
Atbalstītie makrosi ir aprakstīti lapā Atbalstītie makrosi.

Ziņojuma veidne

Ziņojuma veidnes objekts definē veidni, kas tiks izmantota kā noklusējuma ziņojums darbību operācijām, lai nosūtītu paziņojumu. Tam ir šādas īpašības.

Īpašība Type Apraksts
eventsource integer Notikuma avots.

Iespējamās vērtības:
0 - Trigeri;
1 - Atklāšana;
2 - Automātiskā reģistrācija;
3 - Iekšējs;
4 - Pakalpojumi.

Īpašības darbība:
- required
recovery integer Operācijas režīms.

Iespējamās vērtības:
0 - Operācijas;
1 - Atkopšanas operācijas;
2 - Atjaunināšanas operācijas.

Īpašības darbība:
- required
subject string Ziņojuma temats.
message string Ziņojuma teksts.