Mediju tipa objekts

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

Multivides veids

Multivides veida objektam ir šādas īpašības.

Īpašība Tips Apraksts
mediatypeid ID Multivides veida ID.

Īpašības darbība:
- tikai lasāms
- obligāts atjaunināšanas darbībām
name string Multivides veida nosaukums.

Īpašības darbība:
- obligāts izveides darbībām
type integer Multivides veida izmantotais transporta veids.

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

Īpašības darbība:
- obligāts izveides darbībām
exec_path string Skripta faila nosaukums (piemēram, notification.sh), kas atrodas direktorijā, kura norādīta servera konfigurācijas parametrā AlertScriptsPath.

Īpašības darbība:
- obligāts, ja type ir iestatīts uz "Script"
gsm_modem string GSM modema seriālās ierīces nosaukums.

Īpašības darbība:
- obligāts, ja type ir iestatīts uz "SMS"
passwd string Autentifikācijas parole.

Īpašības darbība:
- 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 nosūtīti paziņojumi.

Īpašības darbība:
- obligāts, ja type ir iestatīts uz "Email"
smtp_helo string SMTP HELO.

Īpašības darbība:
- atbalstīts, ja type ir iestatīts uz "Email"
smtp_server string SMTP serveris.

Īpašības darbība:
- obligāts, ja type ir iestatīts uz "Email"
smtp_port integer SMTP servera ports, ar kuru izveidot savienojumu.

Noklusējums: 25.

Īpašības darbība:
- 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.

Īpašības darbība:
- atbalstīts, ja type ir iestatīts uz "Email"
smtp_verify_host integer SMTP SSL resursdatora pārbaude.

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

Īpašības darbība:
- atbalstīts, ja smtp_security ir iestatīts uz "STARTTLS" vai "SSL/TLS"
smtp_verify_peer integer SMTP SSL partnera pārbaude.

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

Īpašības darbība:
- 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 - Normal password;
2 - OAuth token.
OAuth autentifikācija nav atļauta Office365 relay e-pasta pakalpojumu sniedzējam.

Īpašības darbība:
- atbalstīts, ja type ir iestatīts uz "Email"
redirection_url string Zabbix lietotāja saskarnes URL, uz kuru novirzīt atpakaļ OAuth autorizācijai.

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

Īpašības darbība:
- obligāts, ja smtp_authentication ir iestatīts uz "OAuth token"
client_id string OAuth autorizācijas serverī reģistrētais klienta identifikators.

Īpašības darbība:
- obligāts, ja smtp_authentication ir iestatīts uz "OAuth token"
client_secret string OAuth autorizācijas serverī reģistrētais klienta noslēpums. Pieejams tikai lietotājam ar Super Admin tipu.

Īpašības darbība:
- obligāts, ja smtp_authentication ir iestatīts uz "OAuth token"
authorization_url string OAuth URL ar parametriem piekļuves un atjaunošanas pilnvaru iegūšanai.

Īpašības darbība:
- obligāts, ja smtp_authentication ir iestatīts uz "OAuth token"
token_url string OAuth URL autorizācijas pilnvaras apmaiņai pret piekļuves un atjaunošanas pilnvarām.
Šo URL serveris izmanto arī nederīgas piekļuves pilnvaras atjaunošanai.

Īpašības darbība:
- obligāts, ja smtp_authentication ir iestatīts uz "OAuth token"
tokens_status integer Bitu maska pilnvaru statusam.

Iespējamās vērtības:
0 - (noklusējums) Abas pilnvaras satur nederīgu vērtību
1 - Piekļuves pilnvara satur derīgu vērtību
2 - Atjaunošanas pilnvara satur derīgu vērtību
3 - Abas pilnvaras satur derīgu vērtību.

Īpašības darbība:
- atbalstīts, ja smtp_authentication ir iestatīts uz "OAuth token"
access_token string OAuth piekļuves pilnvaras vērtība.

Īpašības darbība:
- obligāts, ja smtp_authentication ir iestatīts uz "OAuth token"
access_token_updated timestamp Pēdējās access_token izmaiņas laika zīmogs, ko serveris izveidojis, atjaunojot to ar refresh_token, vai API izveidojis, mainot pilnvaras.

Īpašības darbība:
- 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, atjaunojot access_token, vai API, mainot pilnvaras.

Laika zīmogu aprēķina, pieskaitot access_token_updated vērtību.

Īpašības darbība:
- atbalstīts, ja smtp_authentication ir iestatīts uz "OAuth token"
refresh_token string OAuth atjaunošanas pilnvaras vērtība.

Īpašības darbība:
- obligāts, ja smtp_authentication ir iestatīts uz "OAuth token"
status integer Norāda, vai multivides veids ir iespējots.

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

Īpašības darbība:
- atbalstīts, ja smtp_authentication ir iestatīts uz "Normal password"
maxsessions integer Maksimālais paralēli apstrādājamo paziņojumu skaits.

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 paziņojuma nosūtīšanai.

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

Noklusējums: 3.
attempt_interval string Intervāls starp atkārtotiem mēģinājumiem.
Pieņem sekunžu skaitu (piemēram, 1, 30, 60) vai vērtību ar laika sufiksu (piemēram, 30s, 1m, 1h).

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.

Īpašības darbība:
- atbalstīts, ja type ir iestatīts uz "Email"
script text Webhook skripta pamatteksts (JavaScript).

Īpašības darbība:
- obligāts, ja type ir iestatīts uz "Webhook"
timeout string Webhook skripta taimauts.
Pieņem sekunžu skaitu (piemēram, 1, 60) vai vērtību ar laika sufiksu (piemēram, 30s, 1m)

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

Noklusējums: 30s.

Īpašības darbība:
- 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ā tagus. Šie tagi tiek pievienoti visiem esošajiem problēmu tagiem.

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

Īpašības darbība:
- atbalstīts, ja type ir iestatīts uz "Webhook"
show_event_menu integer Iekļaut notikumu izvēlnē ierakstu, kas novirza uz pielāgotu URL. problem.get un event.get izvadei tiek pievienota arī urls īpašība.

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

Īpašības darbība:
- atbalstīts, ja type ir iestatīts uz "Webhook"
event_menu_url string URL, kas tiek izmantots notikumu izvēlnes ierakstā un urls īpašībā, ko atgriež problem.get un event.get.

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

Īpašības darbība:
- atbalstīts, ja show_event_menu ir iestatīts uz "Include event menu entry and urls property"
parameters array Webhook vai skripta parametri.

Īpašības darbība:
- atbalstīts, ja type ir iestatīts uz "Webhook" vai "Script"
description text Multivides veida 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.