Mediju tipa objekts

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

Mediju tips

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

Property Type Description
mediatypeid ID Mediju tipa ID.

Property behavior:
- read-only
- required for update operations
name string Mediju tipa nosaukums.

Property behavior:
- required for create operations
type integer Mediju tipa izmantotais transports.

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

Property behavior:
- required for create operations
exec_path string Skripta faila nosaukums (piem., notification.sh), kas atrodas direktorijā, kas norādīta servera konfigurācijas parametrā AlertScriptsPath.

Property behavior:
- required if type is set to "Script"
gsm_modem string GSM modema seriālās ierīces nosaukums.

Property behavior:
- required if type is set to "SMS"
passwd string Autentifikācijas parole.

Property behavior:
- supported if smtp_authentication is set to "Normal password"
provider integer E-pasta pakalpojumu sniedzējs.

Iespējamās vērtības:
0 - (default) 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:
- required if type is set to "Email"
smtp_helo string SMTP HELO.

Property behavior:
- supported if type is set to "Email"
smtp_server string SMTP serveris.

Property behavior:
- required if type is set to "Email"
smtp_port integer SMTP servera ports, ar kuru izveidot savienojumu.

Default: 25.

Property behavior:
- supported if type is set to "Email"
smtp_security integer Izmantojamais SMTP savienojuma drošības līmenis.

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

Property behavior:
- supported if type is set to "Email"
smtp_verify_host integer SSL verifikācija SMTP resursdatoram.

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

Property behavior:
- supported if smtp_security is set to "STARTTLS" or "SSL/TLS"
smtp_verify_peer integer SSL vienaudža verifikācija SMTP.

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

Property behavior:
- supported if smtp_security is set to "STARTTLS" or "SSL/TLS"
smtp_authentication integer Izmantojamā SMTP autentifikācijas metode.

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

Property behavior:
- supported if type is set to "Email"
redirection_url string Zabbix lietotāja saskarnes URL, uz kuru novirzīt OAuth autorizācijas atbildi.

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

Property behavior:
- required if smtp_authentication is set to "OAuth token"
client_id string Klienta identifikators, kas reģistrēts OAuth autorizācijas serverī.

Property behavior:
- required if smtp_authentication is set to "OAuth token"
client_secret string Klienta noslēpums, kas reģistrēts OAuth autorizācijas serverī. Pieejams tikai lietotājam ar Super Admin tipu.

Property behavior:
- required if smtp_authentication is set to "OAuth token"
authorization_url string OAuth URL ar parametriem piekļuves un atsvaidzināšanas marķieru iegūšanai.

Property behavior:
- required if smtp_authentication is set to "OAuth token"
token_url string OAuth URL autorizācijas marķiera apmaiņai pret piekļuves un atsvaidzināšanas marķieriem.
Šo URL serveris izmanto arī nederīga piekļuves marķiera atsvaidzināšanai.

Property behavior:
- required if smtp_authentication is set to "OAuth token"
tokens_status integer Bitu maska marķieru statusam.

Iespējamās vērtības:
0 - (default) 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:
- supported if smtp_authentication is set to "OAuth token"
access_token string OAuth piekļuves marķiera vērtība.

Property behavior:
- required if smtp_authentication is set to "OAuth token"
access_token_updated timestamp Pēdējās access_token izmaiņas laikspiedols, ko serveris veica, atsvaidzinot ar refresh_token vai izmantojot API marķiera izmaiņu laikā.

Property behavior:
- supported if smtp_authentication is set to "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ķiera izmaiņu laikā.

Laikspiedols tiek aprēķināts, pieskaitot access_token_updated vērtību.

Property behavior:
- supported if smtp_authentication is set to "OAuth token"
refresh_token string OAuth atsvaidzināšanas marķiera vērtība.

Property behavior:
- required if smtp_authentication is set to "OAuth token"
status integer Vai mediju tips ir iespējots.

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

Property behavior:
- supported if smtp_authentication is set to "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.

Default: 1.
maxattempts integer Maksimālais mēģinājumu skaits brīdinājuma nosūtīšanai.

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

Default: 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.

Default: 10s.
message_format integer Ziņojuma formāts.

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

Property behavior:
- supported if type is set to "Email"
script text Webhook skripta saturs (JavaScript).

Property behavior:
- required if type is set to "Webhook"
timeout string Webhook skripta taimauts.
Pieņem sekundes un laika vienību ar sufiksu.

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

Default: 30s.

Property behavior:
- supported if type is set to "Webhook"
process_tags integer Apstrādāt JSON īpašību vērtības Webhook skripta atbildē kā tagus. Šie tagi tiek pievienoti jebkuriem esošajiem problēmas tagiem.

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

Property behavior:
- supported if type is set to "Webhook"
show_event_menu integer Iekļaut ierakstu notikumu izvēlnē, kas norāda uz pielāgotu URL. Tāpat pievieno urls īpašību problem.get un event.get izvadei.

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

Property behavior:
- supported if type is set to "Webhook"
event_menu_url string URL, kas tiek izmantots notikumu izvēlnes ierakstā un urls īpašībā, ko atgriež problem.get un event.get.

Property behavior:
- supported if show_event_menu is set to "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.

Property behavior:
- supported if show_event_menu is set to "Include event menu entry and urls property"
parameters array Webhook vai skripta parametri.

Property behavior:
- supported if type is set to "Webhook" or "Script"
description text Mediju 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.