Mediju tipa objekts

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

Multivides tips

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

Property Type Description
mediatypeid ID Multivides tipa ID.

Īpašības darbība:
- tikai lasāma
- obligāta atjaunināšanas darbībām
name string Multivides tipa nosaukums.

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

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

Īpašības darbība:
- obligāta 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āta, ja type iestatīts uz "Script"
gsm_modem string GSM modema seriālās ierīces nosaukums.

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

Īpašības darbība:
- atbalstīta, ja smtp_authentication iestatīts uz "Normal password"
provider integer E-pasta pakalpojumu sniedzējs.

Iespējamās vērtības:
0 - (noklusējuma) 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āta, ja type iestatīts uz "Email"
smtp_helo string SMTP HELO.

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

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

Noklusējums: 25.

Īpašības darbība:
- atbalstīta, ja type iestatīts uz "Email"
smtp_security integer Izmantojamais SMTP savienojuma drošības līmenis.

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

Īpašības darbība:
- atbalstīta, ja type iestatīts uz "Email"
smtp_verify_host integer SMTP SSL hosts verifikācija.

Iespējamās vērtības:
0 - (noklusējuma) No;
1 - Yes.

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

Iespējamās vērtības:
0 - (noklusējuma) No;
1 - Yes.

Īpašības darbība:
- atbalstīta, ja smtp_security iestatīts uz "STARTTLS" vai "SSL/TLS"
smtp_authentication integer Izmantojamā SMTP autentifikācijas metode.

Iespējamās vērtības:
0 - (noklusējuma) None;
1 - Normal password;
2 - OAuth token.
OAuth autentifikācija nav atļauta Office365 relay e-pasta pakalpojumu sniedzējam.

Īpašības darbība:
- atbalstīta, ja type 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āta, ja smtp_authentication iestatīts uz "OAuth token"
client_id string OAuth autorizācijas serverī reģistrētais klienta identifikators.

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

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

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

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

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

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

Īpašības darbība:
- obligāta, ja smtp_authentication iestatīts uz "OAuth token"
access_token_updated timestamp Pēdējo access_token izmaiņu laikspiedols, ko serveris izveidojis, atsvaidzinot ar refresh_token, vai API, mainot pilnvaras.

Īpašības darbība:
- atbalstīta, ja smtp_authentication 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, mainot pilnvaras.

Laikspiedolu aprēķina, pieskaitot vērtību access_token_updated.

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

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

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

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

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

Iespējamās vērtības, ja type 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ējuma) HTML.

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

Īpašības darbība:
- obligāta, ja type 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īta, ja type 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ējuma) Ignorēt Webhook skripta atbildi;
1 - Apstrādāt Webhook skripta atbildi kā tagus.

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

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

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

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

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

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